DOC: Fix documentation warnings

.vscode/settings.json

@@ -34,12 +34,19 @@
         "autopep",
         "autouse",
         "axhline",
+        "axisymmetric",
         "axup",
         "axvline",
+        "axvspan",
         "Barrowman",
         "behaviour",
+        "Bigl",
+        "Bigr",
         "bijective",
+        "bmatrix",
+        "boldsymbol",
         "brentq",
+        "bysource",
         "Calebe",
         "calisto",
         "Calisto",
@@ -53,31 +60,40 @@
         "cftime",
         "changealphaint",
         "Chassikos",
+        "chisquare",
         "clabel",
         "clalpha",
         "cmap",
         "cmcens",
         "coeff",
         "coeffs",
+        "Colab",
         "colorbar",
         "colormaps",
         "contourf",
         "conusnest",
+        "copybutton",
         "cstride",
         "csys",
         "datapoints",
         "datetime",
         "ddot",
+        "deepcopy",
         "deletechars",
         "dimgrey",
         "discretizes",
         "disp",
+        "displaystyle",
+        "docstrings",
         "Doretto",
         "dtype",
+        "dunder",
+        "Dyllon",
         "ECMWF",
         "edgecolor",
         "epsabs",
         "epsrel",
+        "eqsv",
         "errstate",
         "evals",
         "exponentiated",
@@ -88,12 +104,16 @@
         "fftfreq",
         "figsize",
         "filt",
+        "firstsimulation",
+        "Fluxogram",
         "fmax",
         "fmin",
+        "fontawesome",
         "fontsize",
         "freestream",
         "funcified",
         "funcify",
+        "functionusage",
         "GEFS",
         "genfromtxt",
         "geopotential",
@@ -109,12 +129,15 @@
         "Gomes",
         "Gonçalvez",
         "grav",
+        "Guilherme",
         "hemis",
         "hgtprs",
         "hgtsfc",
         "HIRESW",
         "HRES",
         "hspace",
+        "htmlhelp",
+        "hybridmotor",
         "ICONEU",
         "idxmax",
         "IGRA",
@@ -124,9 +147,11 @@
         "interp",
         "Interquartile",
         "intp",
+        "ipynb",
         "ipywidgets",
         "isbijective",
         "isin",
+        "ivar",
         "jsonpickle",
         "Junqueira",
         "jupyter",
@@ -135,25 +160,35 @@
         "linalg",
         "linestyle",
         "linewidth",
+        "linspace",
+        "liquidmotor",
         "loadtxt",
+        "lognormal",
         "LSODA",
         "lvhaack",
         "Mandioca",
         "Marte",
         "Masatoshi",
         "Mateus",
+        "mathbf",
         "Matheus",
+        "mathjax",
+        "mathrm",
         "mathutils",
+        "matplotlib",
         "maxdepth",
         "mbar",
         "meshgrid",
         "Mesoscale",
         "Meteo",
         "Meteomatics",
         "Metrum",
+        "modindex",
         "mult",
         "Mumma",
         "NASADEM",
+        "nbformat",
+        "nbsphinx",
         "NCEP",
         "NDAP",
         "ndarray",
@@ -163,27 +198,41 @@
         "newmultigeometry",
         "newpolygon",
         "nfev",
+        "Niskanen",
         "NOAA",
         "NOAA's",
         "noaaruc",
         "noaarucsounding",
         "num2pydate",
+        "numfig",
         "numpy",
+        "numref",
         "outerboundaryis",
+        "overshootable",
         "planform",
         "polystyle",
         "powerseries",
+        "Prandtl",
         "Projeto",
         "prometheus",
+        "pydata",
+        "pylint",
+        "PYPI",
+        "pyplot",
+        "pyproject",
         "pytz",
         "Rdot",
         "referece",
         "relativetoground",
+        "repr",
         "reynolds",
+        "rightarrow",
         "ROABs",
         "rocketpy",
+        "rocketusage",
         "rstride",
         "rtol",
+        "rtype",
         "rucsoundings",
         "rwork",
         "savetxt",
@@ -192,24 +241,30 @@
         "scilimits",
         "searchsorted",
         "seealso",
+        "setrail",
         "simplekml",
         "SIRGAS",
+        "solidmotor",
         "somgl",
         "Somigliana",
+        "Sorban",
         "sqrd",
         "SRTM",
         "SRTMGL",
         "Stano",
         "subintervals",
+        "suptitle",
         "ticklabel",
         "timedelta",
         "timezonefinder",
         "tmpprs",
         "toctree",
         "trapz",
         "TRHEDDS",
+        "triggerdetails",
         "triggerfunc",
         "twinx",
+        "typehints",
         "udot",
         "ufunc",
         "ugrdprs",
@@ -218,6 +273,7 @@
         "uwyo",
         "vectorize",
         "vgrdprs",
+        "viewcode",
         "viridis",
         "vmax",
         "vmin",
@@ -234,6 +290,7 @@
         "ylim",
         "zdir",
         "zlabel",
-        "zlim"
+        "zlim",
+        "zorder"
     ]
 }

CHANGELOG.md

@@ -36,6 +36,7 @@ Attention: The newest changes should be on top -->
 ### Changed
 
 - 
+- DOC: Fix documentation warnings [#645](https://github.com/RocketPy-Team/RocketPy/pull/645)
 - DOC: New Environment class docs pages [#644](https://github.com/RocketPy-Team/RocketPy/pull/644)
 
 ### Fixed

docs/conf.py

@@ -1,3 +1,5 @@
+# pylint: skip-file
+
 # Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full
@@ -38,13 +40,22 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx.ext.mathjax",
+    "sphinx_copybutton",
     "sphinx_design",
     "jupyter_sphinx",
     "nbsphinx",
 ]
 
-# source_suffix = '.rst'
-# source_suffix = ['.rst', '.md']
+
+# Compatibility: https://about.readthedocs.com/blog/2024/07/addons-by-default/
+## Define the canonical URL if you are using a custom domain on Read the Docs
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+## Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+    if "html_context" not in globals():
+        html_context = {}
+    html_context["READTHEDOCS"] = True
 
 # Don't run notebooks
 nbsphinx_execute = "never"
@@ -71,7 +82,7 @@
 # -- Options for autodoc ----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
 
-# Automatically extract typehints when specified and place them in
+# Automatically extract type hints when specified and place them in
 # descriptions of the relevant function/method.
 autodoc_typehints = "description"
 
@@ -90,20 +101,14 @@
 # a list of builtin themes.
 #
 html_theme = "pydata_sphinx_theme"
+numfig = True
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["static"]
 html_css_files = ["rocketpy.css"]
 html_favicon = "static/favicon.ico"
-html_theme_options = {
-    "logo_link": "index",
-    "github_url": "https://github.com/RocketPy-Team/RocketPy",
-    "collapse_navigation": True,
-    "show_toc_level": 4,
-    "show_nav_level": 4,
-}
 
 html_sidebars = {
     "**": ["search-field.html", "sidebar-nav-bs.html", "sidebar-ethical-ads.html"]
@@ -113,6 +118,9 @@
         "image_light": "static/RocketPy_Logo_black.png",
         "image_dark": "static/RocketPy_Logo_white.png",
     },
+    "navigation_with_keys": False,
+    "collapse_navigation": True,
+    "github_url": "https://github.com/RocketPy-Team/RocketPy",
     "navbar_end": ["theme-switcher", "navbar-icon-links.html"],
     "icon_links": [
         {

docs/development/build_docs.rst

@@ -73,8 +73,10 @@ by running the ``make html`` command.
 If the error persists, it may be related to other files, such as the ``.rst``
 files or the ``conf.py`` file.
 
-.. danger:: Do not modify the Makefile or the ``make.bat`` files. These files are
-            automatically generated by sphinx and any changes will be lost.
+.. danger::
+
+    Do not modify the Makefile or the ``make.bat`` files. These files are \
+    automatically generated by sphinx and any changes will be lost.
 
 
 How to integrate the documentation with ReadTheDocs
@@ -92,6 +94,8 @@ The connection between the GitHub repository and the `ReadTheDocs` project is
 already configured and defined in the ``readthedocs.yml`` file, available at the
 root of the repository.
 
-.. note:: You need admin permissions to configure the `ReadTheDocs` project. Ask
-          the team for help if you don't have admin permissions.
+.. note::
+
+    You need admin permissions to configure the `ReadTheDocs` project. Ask \
+    the team for help if you don't have admin permissions.