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

Add Sphinx autosummary and ReadTheDocs deployment to Sphinx documentation article #86

Open
ns-rse opened this issue Sep 13, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ns-rse
Copy link
Owner

ns-rse commented Sep 13, 2023

Add details on autogenerating API documentation using
sphinx_ext_autosummary (and the recursive directive) to automatically generate API documentation.

Further add a section on deploying to ReadTheDocs and how to get multiple versions of
documentation building and switching between them (see pgfinder for example).

@ns-rse ns-rse added the documentation Improvements or additions to documentation label Sep 13, 2023
@ns-rse ns-rse self-assigned this Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant