-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Render python native docs alongside API docs #166
Render python native docs alongside API docs #166
Conversation
…olete. Include python native docs alongside api docs
Thanks! Three questions/comments:
which list where? In the future, when adding a Python-native function to an existing tudatpy submodules and making sure the documentation shows up properly, what are all the steps that should be taken? Documentation for this can be a separate PR. If the point:
is purely aesthetic, let's put it in a different PR, then we can already test this out in our full pipeline. |
@DominicDirkx I was referring to this list: Should the docstrings in the python native modules marked as 'Keep' be rendered on the API docs website in the same way as the docstrings in horizons_wrapper.py and sbdb_wrapper.py are rendered in this PR? |
Right, thanks! Yes, they should also be rendered along with the rest, but some files (starting with an underscore, I think) contain private functions that should not be part of the API. |
…le by next command
d85ad40
to
6cab67a
Compare
d619215
to
9380794
Compare
This pull request addresses two separate issues:
Next StepsTo maintain clarity, and ensure each issue is handled individually, this pull request will be closed. Two new pull requests will be created, each addressing one of the above issues separately. This will help keep the changes organized and easier to review. |
This PR closes #144. Currently, the docstrings from python native modules are not being rendered on the API documentation website.
Summary of changes
- https://github.com/tudat-team/tudatpy/tree/develop/tudatpy/numerical_simulation/environment_setup/gravity_field
- https://github.com/tudat-team/tudatpy/tree/develop/tudatpy/numerical_simulation/environment_setup/ephemeris
Testing
The read the docs deployment of the changes in this PR can be viewed here: https://py.api.tudat.space/en/feature-144-include-python-native-docstrings/
Python native docstrings are rendered in https://py.api.tudat.space/en/feature-144-include-python-native-docstrings/ephemeris.html and https://py.api.tudat.space/en/feature-144-include-python-native-docstrings/gravity_field.html
To do