Skip to content

Docs that can build #25

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

Open
thc1006 wants to merge 2 commits into
base: develop
Choose a base branch
from
+7 −6
Open

Docs that can build #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afdb032
Docs that can build
thc1006 Jul 29, 2026
dab3ed5
Run the docs check before the release merge, not at it
thc1006 Jul 29, 2026
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
9 changes: 6 additions & 3 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
name: Documentation

on:
# Only PRs targeting master (base branch = master) and pushes to master.
# develop as well as master. Work lands on develop first, so a base of master
# alone meant the only run was the release pull request: a docstring that does
# not build sat on develop until then and failed the merge that was supposed
# to ship it, which is how the four warnings this fixes went unnoticed.
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
branches: [master]
branches: [master, develop]
paths:
- "docs/**"
- "rocketpy/**" # docstrings feed the autodoc API reference
Expand All @@ -13,7 +16,7 @@ on:
- ".readthedocs.yaml"
- ".github/workflows/docs.yml"
push:
branches: [master]
branches: [master, develop]
paths:
- "docs/**"
- "rocketpy/**"
Expand Down
1 change: 1 addition & 0 deletions docs/examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ In the next sections you will find the simulations of the rockets listed above.
prometheus_2022_flight_sim.ipynb
erebus_flight_sim.ipynb
halcyon_flight_sim.ipynb
halcyon_flight_sim_active_control.ipynb
cavour_flight_sim.ipynb
genesis_flight_sim.ipynb
camoes_flight_sim.ipynb
Expand Down
3 changes: 0 additions & 3 deletions rocketpy/rocket/rocket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2004,7 +2004,6 @@ def add_thrust_vector_control(
rocket. The most recent measurements of the sensors are provided
with the ``sensor.measurement`` attribute. The sensors are
listed in the same order as they are added to the rocket
``interactive_objects``

This function will be called during the simulation at the specified
sampling rate. The function should evaluate and change the observed
Expand Down Expand Up @@ -2164,7 +2163,6 @@ def add_roll_control(
rocket. The most recent measurements of the sensors are provided
with the ``sensor.measurement`` attribute. The sensors are
listed in the same order as they are added to the rocket
`interactive_objects`

This function will be called during the simulation at the specified
sampling rate. The function should evaluate and change the observed
Expand Down Expand Up @@ -2300,7 +2298,6 @@ def add_throttle_control(
rocket. The most recent measurements of the sensors are provided
with the ``sensor.measurement`` attribute. The sensors are
listed in the same order as they are added to the rocket
``interactive_objects``

This function will be called during the simulation at the specified
sampling rate. The function should evaluate and change the observed
Expand Down
Loading