Add Full Sphinx Documentation Support with API Autogeneration and CI Integration #19
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces full Sphinx documentation support to the project, enabling documentation to be built locally, in CI, and on Read the Docs. It also adds the necessary scaffolding for automatic API documentation generation.
Changes
Add Sphinx Documentation Structure
docs/directory with Sphinx setupMakefileandmake.batfor building docs locallydocs/source/conf.pywith configuration and extensions (autodoc,autosummary,napoleon, etc.)docs/source/index.rstas documentation entry pointindex.md,installation.md)Add Documentation Build Support
.readthedocs.yamlto enable Read the Docs builds with Python 3.13extra_requirements: docsAutomatic API Documentation Support
autosummary_generate = Trueto allow auto API page generationviewcode,copybutton,mathjax,intersphinx,nbsphinx, etc.)autosummary/autodocImpact
api.rst)