Skip to content

Commit afdb032

Browse files
committed
Docs that can build
The docs job has failed on every run since it was added: five runs, back to 2026-07-26, all red. `sphinx-build -W` turns four warnings into errors, and all four come from this fork's own additions rather than from upstream. Three are one stray line, copied three times. `add_thrust_vector_control`, `add_roll_control` and `add_throttle_control` describe the controller arguments as a numbered list, and item 7 ends with a loose ``interactive_objects`` at one space less than the continuation lines above it. docutils reads that as a definition list ending without a blank line. The same item in upstream's `add_air_brakes` does not have it, so removing it puts these three back in step with the method they were copied from. Measured per docstring, running napoleon and docutils the way Sphinx does. Before: those three warn at line 28, `add_air_brakes` does not. After: none of the four warn. The fourth is `halcyon_flight_sim_active_control.ipynb`, which is in `docs/examples/` and in no toctree, so Sphinx builds it and then reports that nothing links to it. It is this fork's own example of the feature the fork exists for, so it goes in the list next to the flight it varies rather than into an exclude. Not verified by a full local build: an unrelated notebook fetches a live weather forecast and the file it reaches no longer covers the date it asks for, which stops the build here for a reason CI does not have. Signed-off-by: thc1006 <84045975+thc1006@users.noreply.github.com>
1 parent b3f1d77 commit afdb032

2 files changed

Lines changed: 1 addition & 3 deletions

File tree

docs/examples/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ In the next sections you will find the simulations of the rockets listed above.
106106
prometheus_2022_flight_sim.ipynb
107107
erebus_flight_sim.ipynb
108108
halcyon_flight_sim.ipynb
109+
halcyon_flight_sim_active_control.ipynb
109110
cavour_flight_sim.ipynb
110111
genesis_flight_sim.ipynb
111112
camoes_flight_sim.ipynb

rocketpy/rocket/rocket.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2004,7 +2004,6 @@ def add_thrust_vector_control(
20042004
rocket. The most recent measurements of the sensors are provided
20052005
with the ``sensor.measurement`` attribute. The sensors are
20062006
listed in the same order as they are added to the rocket
2007-
``interactive_objects``
20082007
20092008
This function will be called during the simulation at the specified
20102009
sampling rate. The function should evaluate and change the observed
@@ -2164,7 +2163,6 @@ def add_roll_control(
21642163
rocket. The most recent measurements of the sensors are provided
21652164
with the ``sensor.measurement`` attribute. The sensors are
21662165
listed in the same order as they are added to the rocket
2167-
`interactive_objects`
21682166
21692167
This function will be called during the simulation at the specified
21702168
sampling rate. The function should evaluate and change the observed
@@ -2300,7 +2298,6 @@ def add_throttle_control(
23002298
rocket. The most recent measurements of the sensors are provided
23012299
with the ``sensor.measurement`` attribute. The sensors are
23022300
listed in the same order as they are added to the rocket
2303-
``interactive_objects``
23042301
23052302
This function will be called during the simulation at the specified
23062303
sampling rate. The function should evaluate and change the observed

0 commit comments

Comments
 (0)