Skip to content
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

Draft
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

niketagrawal
Copy link

@niketagrawal niketagrawal commented Sep 4, 2024

This PR closes #144. Currently, the docstrings from python native modules are not being rendered on the API documentation website.

Summary of changes

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

  • Include the remaining python native files. See the list prepared earlier.
  • Document steps to add/update API docs
  • Cleanup multidoc related files form docs/ folder: To be done as a separate PR.

…olete. Include python native docs alongside api docs
@niketagrawal niketagrawal added the documentation-related Suggests that documentation needs enriching label Sep 4, 2024
@niketagrawal niketagrawal self-assigned this Sep 4, 2024
@niketagrawal niketagrawal changed the title python native docs on the apid documentation Render python native docs alongside API docs Sep 4, 2024
@niketagrawal niketagrawal requested review from yiquintero and removed request for yiquintero September 4, 2024 15:09
@DominicDirkx
Copy link
Member

Thanks! Three questions/comments:

Include the remaining python native files. See the list prepared earlier.

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:

Cleanup multidoc related files form docs/ folder

is purely aesthetic, let's put it in a different PR, then we can already test this out in our full pipeline.

@niketagrawal
Copy link
Author

niketagrawal commented Sep 5, 2024

@DominicDirkx I was referring to this list:
python_files_tudat.xlsx

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?

@DominicDirkx
Copy link
Member

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.

@niketagrawal niketagrawal force-pushed the feature/144-include-python-native-docstrings branch from d85ad40 to 6cab67a Compare September 17, 2024 12:10
@niketagrawal niketagrawal force-pushed the feature/144-include-python-native-docstrings branch 2 times, most recently from d619215 to 9380794 Compare September 19, 2024 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-related Suggests that documentation needs enriching
Projects
None yet
3 participants