Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: improve docs before v1 #386

Merged
merged 5 commits into from
Jul 3, 2023
Merged

DOC: improve docs before v1 #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3d0627f
DOC: adding new .rst files to documentation
Gui-FernandesBR Jun 27, 2023
5f2280a
DOC: minor adjustments in the past .rst files
Gui-FernandesBR Jun 27, 2023
32436dd
Merge branch 'beta/v1.0.0' into doc/improve-docs-before-v1
Gui-FernandesBR Jul 1, 2023
a39efc2
DOC: update .rst files to accomplish with alpha
Gui-FernandesBR Jul 1, 2023
40c3e86
DOC: update titles in notebooks.
Gui-FernandesBR Jul 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
15 changes: 15 additions & 0 deletions docs/examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

3 changes: 2 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/notebooks/deployable_payload_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Deployable Payload Flight Simulation Example"
"# Deployable Payload"
]
},
{
Expand Down Expand Up @@ -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"
]
},
{
Expand Down
Loading