Merge pull request #386 from RocketPy-Team/doc/improve-docs-before-v1

DOC: improve docs before v1

Author: giovaniceotto

docs/conf.py

@@ -78,7 +78,8 @@
     "logo_link": "index",
     "github_url": "https://github.com/RocketPy-Team/RocketPy",
     "collapse_navigation": True,
-    "show_toc_level": 3,
+    "show_toc_level": 4,
+    "show_nav_level": 4,
 }
 
 html_sidebars = {

docs/examples/index.rst

@@ -0,0 +1,15 @@
+Flights simulated with RocketPy
+===============================
+
+Apart from the classical Calisto rocket, which is many times used as a
+reference in the getting started tutorial, RocketPy also includes some very
+interesting examples of real rockets.
+
+If you want to see your rocket here, please contact the maintainers!
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   
+   ../notebooks/SEBLM.ipynb
+

docs/index.rst

@@ -4,13 +4,14 @@
    contain the root `toctree` directive.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
    :hidden:
 
    User Guide <user/index>
    Code Reference <reference/index>
    Development <development/index>
    Technical <technical/index>
+   Flight Examples <examples/index>
 
 .. _`RocketPy`: https://www.linkedin.com/company/75016723
 

docs/notebooks/deployable_payload_example.ipynb

@@ -5,7 +5,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Deployable Payload Flight Simulation Example"
+    "# Deployable Payload"
    ]
   },
   {
@@ -37,8 +37,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install rocketpy netCDF4\n",
-    "!git clone https://github.com/RocketPy-Team/RocketPy.git"
+    "%pip install rocketpy netCDF4\n",
+    "%git clone https://github.com/RocketPy-Team/RocketPy.git"
    ]
   },
   {