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

Use tudatpy conda package to build docs on Read the Docs #175

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

Conversation

niketagrawal
Copy link

@niketagrawal niketagrawal commented Sep 30, 2024

This is a follow up to the changes introduced via #157
After pull request #157, tudat-multidoc is no longer needed to build the API documentation locally, however, read the docs continues to use multidoc to build the docs as evident from the body of the if loop in docs/src/conf.py.

Closes #174.

Summary of changes

  • docs.source/conf.py: Modify the steps to build the docs on Read the Docs to use tudatpy conda package instead of multidoc. Point to the location where the binaries are stored, i.e., the location of the installation of tudatpy conda package on the Read the Docs server.
  • .readthedocs.yaml: Read the docs should check out the latest tag instead of local commit to remain consistent with the source it uses to build the docs, i.e., the tudatpy conda package. Use pre-install step to override the default build process.
  • environment_readthedocs.yml: Unpin the tudatpy version to get the latest version. Remove the dependencies that will be installed as part of tudatpy installation such as tudat, boost-cpp, numpy, matplotlib. Pinning Python=3.8 causes the tudatpy dev version to be restricted to max 0.8.0.dev11. This version pinning of python is removed.

Testing

Docs successfully built and rendered by Read the Docs

… tudatpy dev conda package is made using the latest tag so use pre-install step to get the source for latest tag
@niketagrawal niketagrawal self-assigned this Sep 30, 2024
@niketagrawal niketagrawal added the documentation-related Suggests that documentation needs enriching label Sep 30, 2024
@niketagrawal niketagrawal linked an issue Sep 30, 2024 that may be closed by this pull request
@niketagrawal niketagrawal changed the title Use tudatpy dev conda package to build docs on Read the Docs Use tudatpy conda package to build docs on Read the Docs Sep 30, 2024
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
Development

Successfully merging this pull request may close these issues.

Use tudatpy conda package to build docs on Read the Docs
1 participant