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 #174

Closed
niketagrawal opened this issue Sep 30, 2024 · 1 comment · Fixed by #175
Closed

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

niketagrawal opened this issue Sep 30, 2024 · 1 comment · Fixed by #175
Assignees
Labels
documentation-related Suggests that documentation needs enriching enhancement New feature or request

Comments

@niketagrawal
Copy link
Contributor

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.

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.

@niketagrawal niketagrawal added the documentation-related Suggests that documentation needs enriching label Sep 30, 2024
@niketagrawal niketagrawal self-assigned this Sep 30, 2024
@niketagrawal niketagrawal linked a pull request Sep 30, 2024 that will close this issue
@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
@niketagrawal niketagrawal added the enhancement New feature or request label Nov 20, 2024
@niketagrawal
Copy link
Contributor Author

Fixed with PR #175

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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant