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

Feature/150 docstrings #157

Merged
merged 61 commits into from
Sep 4, 2024
Merged

Feature/150 docstrings #157

merged 61 commits into from
Sep 4, 2024

Conversation

yiquintero
Copy link
Contributor

@yiquintero yiquintero commented Jul 31, 2024

See issue #150 for more information about this pull request.

Main changes:

  • Replace the placeholder file for docstrings.h with the one containing all the docstrings (generated by tudat-multidoc)
  • Move header files in include/ to tudatpy/kernel/
  • Add Sphinx .rst files (generated by tudat-bundle cli app) to docs/source

Merging this PR does not change the way the tudatpy API documentation is built on ReadtheDocs. You can see the docs built and rendered in html by read the docs for these changes on https://py.api.tudat.space/en/feature-150-docstrings/

After this PR and PR #19 in tudat-bundle are merged, the user will be able to build the tudatpy API documentation locally by:

  1. creating and activating the conda env in tudat-bundle
  2. building tudat-bundle
  3. running make html from tudat-bundle/tudatpy/docs

DominicDirkx and others added 30 commits December 13, 2023 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

7 participants