Repository navigation
Add Sphinx documentation with auto-generated API reference - #43
Merged
Hector Hernandez (hectorhdzg) merged 3 commits intoApr 20, 2026
Merged
Hector Hernandez (hectorhdzg) merged 3 commits into
Hector Hernandez (hectorhdzg) merged 3 commits into
Conversation
Hector Hernandez (hectorhdzg)
commented
Apr 20, 2026
Member
- Add Sphinx setup with sphinx-rtd-theme, autodoc, napoleon, and typehints
- Use sphinx-apidoc to auto-generate API reference RSTs from source tree
- Add docs/conf.py, index.rst, Makefile, and make.bat
- Add 'docs' optional dependency group in pyproject.toml
- Add 'docs' tox environment for local and CI builds
- Add docs build job to PR validation CI workflow
- Update .gitignore to exclude docs/_build/ and docs/api/
- Add Sphinx setup with sphinx-rtd-theme, autodoc, napoleon, and typehints - Use sphinx-apidoc to auto-generate API reference RSTs from source tree - Add docs/conf.py, index.rst, Makefile, and make.bat - Add 'docs' optional dependency group in pyproject.toml - Add 'docs' tox environment for local and CI builds - Add docs build job to PR validation CI workflow - Update .gitignore to exclude docs/_build/ and docs/api/
Hector Hernandez (hectorhdzg)
requested a review
from Jackson Weber (JacksonWeber)
as a code owner
April 20, 2026 18:41
Hector Hernandez (hectorhdzg)
requested review from
Nev (MSNev),
Jeremy Voss (jeremydvoss),
Leighton Chen (lzchen) and
Radhika Gupta (rads-1996)
as code owners
April 20, 2026 18:41
Radhika Gupta (rads-1996)
approved these changes
Apr 20, 2026
Leighton Chen (lzchen)
approved these changes
Apr 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Sphinx documentation site to the repo and wires it into local/CI tooling so the API reference can be generated from the src/ tree.
Changes:
- Introduces Sphinx configuration and entry docs (
docs/conf.py,docs/index.rst) plus standardMakefile/make.bat. - Adds a
docsoptional dependency group and atox -e docsenvironment that runssphinx-apidocand builds HTML. - Extends PR validation workflow and
.gitignoreto support docs builds and generated outputs.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tox.ini | Adds docs tox environment to generate API RSTs and build Sphinx HTML. |
| pyproject.toml | Adds docs optional dependencies for Sphinx + theme/typehints. |
| docs/conf.py | Sphinx configuration (autodoc/napoleon/typehints/intersphinx/theme). |
| docs/index.rst | Root toctree pointing to generated API reference. |
| docs/Makefile | Standard Sphinx make entrypoints for local builds. |
| docs/make.bat | Windows equivalent for local builds. |
| .gitignore | Ignores generated docs build output and API RSTs. |
| .github/workflows/pr-validation.yml | Adds CI job to build docs via tox. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…cate deps - Fix sys.path in conf.py to be relative to conf.py, not CWD - Add apidoc generation step to Makefile and make.bat so standalone builds work - Remove duplicated sphinx deps from tox.ini, use pip install -e .[docs] instead
Radhika Gupta (rads-1996)
approved these changes
Apr 20, 2026
Hector Hernandez (hectorhdzg)
merged commit Apr 20, 2026
8fab154
into
microsoft:main
8 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.