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.

Sign up for GitHub

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

Jump to bottom

Migrate docs from sphinx-apidoc to sphinx-autoapi #27

Open
wolearyc opened this issue Sep 25, 2024 · 0 comments
Open

Migrate docs from sphinx-apidoc to sphinx-autoapi #27

wolearyc opened this issue Sep 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@wolearyc
Copy link
Owner

Sphinx-autoapi produces better-organized documentation and makes it easier to restrict documentation to the public API. However, sphinx-autoapi has a possible bug preventing intersphinx from working properly.

See readthedocs/sphinx-autoapi#483.
@wolearyc wolearyc added the documentation Improvements or additions to documentation label Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wolearyc