-
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
Include Python native docstrings on the API docs website #144
Labels
documentation-related
Suggests that documentation needs enriching
Comments
niketagrawal
added
the
documentation-related
Suggests that documentation needs enriching
label
Apr 10, 2024
Implementation in WIP/extract-docs-from-python-modules
|
niketagrawal
changed the title
Proof of concept: Include Python native docs on the API docs page
Include Python native docs on the API docs page
May 3, 2024
Work on this issue will be resumed after #146 |
niketagrawal
changed the title
Include Python native docs on the API docs page
[BUG] Include Python native docs on the API docs page
May 6, 2024
Python native modules which need to rendered together with the API docs |
Proof of concept for rendering the docstrings for Python native code (for the two modules listed above) alongside that of the bindings
Test status on Read the DocsChanges work fine on read the docs. See the rendered docs for this proof of concept: https://py.api.tudat.space/en/144-render-python-native-docs/ Points to address going forward
|
2 tasks
2 tasks
2 tasks
niketagrawal
changed the title
[BUG] Include Python native docs on the API docs page
Include Python native docstrings on the API docs website
Sep 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Documentation (docstrings) from the pure Python modules in the tudatpy repository should appear on the API docs page alongside the API docs for the bindings.
The text was updated successfully, but these errors were encountered: