API Docs Update #491
API Docs Update #491
Conversation
|
Thanks a lot for the pull request @IngenieroDeAviones! There are some minor PEP8 failures, you can check them by clicking the Circle CI report: https://circleci.com/gh/poliastro/poliastro/1006 Also, is this finished or do you intend to add more commits to it? |
|
The idea is to keep adding more commits, at least one per module for poliastro.core and the high-level API |
Codecov Report
@@ Coverage Diff @@
## master #491 +/- ##
=======================================
Coverage 86.04% 86.04%
=======================================
Files 49 49
Lines 2186 2186
Branches 166 166
=======================================
Hits 1881 1881
Misses 265 265
Partials 40 40
Continue to review full report at Codecov.
|
|
The test failures now are because of the doctests, for example https://circleci.com/gh/poliastro/poliastro/1014 |
|
For the moment, I think this should be enough to give the |
There was a problem hiding this comment.
Well, that was a long review for a long pull requests! I left lots of comments, hope you don't feel overwhelmed. Some of them are whitespace changes or one letter changes. I also realized some problems that I'd like to manage in future pull requests. Overall, great job!
| @@ -37,6 +37,7 @@ | |||
| 'sphinx.ext.intersphinx', | |||
There was a problem hiding this comment.
Talking about extensions: intersphinx inventory has moved: http://matplotlib.org/objects.inv -> https://matplotlib.org/objects.inv.
| @@ -0,0 +1,5 @@ | |||
| Angles | |||
There was a problem hiding this comment.
When I build the documentation locally this page appears empty. Do you know why?
|
The main challenge now will be to rebase it on current master, because after the Black restyling there are lots of merge conflicts. I will lend a hand with that when you're done pushing @IngenieroDeAviones 💪 |
|
I finally added more information on NEOs and also Orbit module. Waiting for your suggestions and code review @Juanlu001 😄 |
astrojuanlu
force-pushed
the
API_Docs
branch
from
ec92367 to
cda749c
Compare
ghost
assigned
This commit adds the following features to the core.utils documentation: [+] Possibility of adding matrix in latex form [+] Examples of how functions work
This commit includes: [+] New description for Stumpff Module
This commit includes: [+] New elements documentation [+] Latex formulas for core.elements [+] Several examples for each function of the module
This commit tries to fix pep-8 style of previous commited scripts
A new structure, more readable for users has been applied also with a new folder tree containing the rst files for each module
Improved rst files
Added more info about Neos, Iod and Orbit modules
astrojuanlu
force-pushed
the
API_Docs
branch
from
cda749c to
224ce41
Compare
Solve example M_to_nu
jorgepiloto
force-pushed
the
API_Docs
branch
from
cec4b7c to
b0cee3c
Compare
Due to its new location in threebody module
|
Wohooooooo merging! 🎉 It took a while but I was so excited about the results. Great job @IngenieroDeAviones, looking forward to collaborating in the future 😉 |
This pull request has as an objective updating all the API documentation of poliastro project, including:
Formatting edits by @Juanlu001