Commit afdb032
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
106 | 106 | | |
107 | 107 | | |
108 | 108 | | |
| 109 | + | |
109 | 110 | | |
110 | 111 | | |
111 | 112 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2004 | 2004 | | |
2005 | 2005 | | |
2006 | 2006 | | |
2007 | | - | |
2008 | 2007 | | |
2009 | 2008 | | |
2010 | 2009 | | |
| |||
2164 | 2163 | | |
2165 | 2164 | | |
2166 | 2165 | | |
2167 | | - | |
2168 | 2166 | | |
2169 | 2167 | | |
2170 | 2168 | | |
| |||
2300 | 2298 | | |
2301 | 2299 | | |
2302 | 2300 | | |
2303 | | - | |
2304 | 2301 | | |
2305 | 2302 | | |
2306 | 2303 | | |
| |||
0 commit comments