DOC: New Environment class docs pages #644
Merged
Conversation
This file contains 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
Gui-FernandesBR
added
Docs
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #644 +/- ##
===========================================
+ Coverage 75.71% 75.74% +0.03%
===========================================
Files 81 81
Lines 9815 9822 +7
===========================================
+ Hits 7431 7440 +9
+ Misses 2384 2382 -2 ☔ View full report in Codecov by Sentry. |
Gui-FernandesBR
changed the title
Gui-FernandesBR
force-pushed
the
doc/environment-docs-refactor
branch
from
054fcc2 to
6f31762
Compare
|
Great PR! The documentation was very informative, easy to follow, and well-structured. Users will certainly find it very helpful. |
Gui-FernandesBR
force-pushed
the
doc/environment-docs-refactor
branch
3 times, most recently
from
2987b2b to
7fe81de
Compare
Update docs/user/environment/0-setup/elevation.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/0-setup/elevation.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/0-setup/index.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/3-further/data_csv.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/1-atm-models/forecast.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com>
Gui-FernandesBR
force-pushed
the
doc/environment-docs-refactor
branch
from
747e5cf to
e3c2230
Compare
|
Thank you so much for reviewing all the 25 files of this PR, I understand it has not been an easy task. |
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.
Pull request type
Checklist
black rocketpy/ tests/) has passed locallypytest tests -m slow --runslow) have passed locallyCHANGELOG.mdhas been updated (if relevant)Current behavior
The Environment class documentation is really outdated. We have only one jupyter notebook dated of more than 5 years ago.
New behavior
Environment class documentation is totally refactored! Everything is based on .rst files, which are more modern and organized.
Breaking change
Additional information