DOCs: Fix documentation build #908
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…atting in simulation files
Gui-FernandesBR
force-pushed
the
docs/fixes
branch
from
b852bd8 to
e6a3d2b
Compare
There was a problem hiding this comment.
Pull request overview
This PR fixes documentation build errors by addressing import ordering, docstring formatting, and documentation file issues.
Key Changes
- Alphabetized imports across multiple files to comply with isort requirements
- Reformatted docstring for
calculate_rail_button_bending_momentsmethod to better follow NumPy style guide conventions - Added
FlightComparatorto public API exports with an__all__definition inrocketpy/simulation/__init__.py - Fixed indentation and file paths in RST documentation
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/unit/test_plots.py | Reordered imports alphabetically (matplotlib.animation before other imports) |
| rocketpy/simulation/flight.py | Moved calculate_rail_button_bending_moments method to better location and reformatted docstring to follow NumPy conventions with proper sections (Returns, Notes, Examples) and LaTeX math notation |
| rocketpy/simulation/init.py | Added FlightComparator import and defined __all__ list for explicit API exports |
| rocketpy/plots/tank_plots.py | Alphabetized imports within groups |
| rocketpy/plots/motor_plots.py | Alphabetized imports within groups |
| docs/user/flight_comparator.rst | Fixed indentation for code blocks and corrected file paths from ../data/calisto/ to ../data/rockets/calisto/, removed trailing whitespace |
Comment on lines
+10
to
+12
| "FlightDataExporter", | ||
| "FlightDataImporter", | ||
| "FlightComparator", |
There was a problem hiding this comment.
The order of items in __all__ should match the order of imports for consistency. Currently, FlightComparator appears second in the imports (line 2) but fourth in __all__ (line 12). Consider reordering __all__ to:
__all__ = [
"Flight",
"FlightComparator",
"FlightDataExporter",
"FlightDataImporter",
"MonteCarlo",
"MultivariateRejectionSampler",
]
Suggested change
| "FlightDataExporter", | |
| "FlightDataImporter", | |
| "FlightComparator", | |
| "FlightComparator", | |
| "FlightDataExporter", | |
| "FlightDataImporter", |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Several errors broke the documentations. I"m trying to fix it with this PR.