Skip to content

Add Sphinx documentation with auto-generated API reference - #43

Merged
Hector Hernandez (hectorhdzg) merged 3 commits into
microsoft:mainfrom
hectorhdzg:feature/sphinx-docs
Apr 20, 2026
Merged

Hector Hernandez (hectorhdzg) merged 3 commits into
microsoft:mainfrom
hectorhdzg:feature/sphinx-docs

Conversation

@hectorhdzg

Copy link
Copy Markdown
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/

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 standard Makefile/make.bat.
  • Adds a docs optional dependency group and a tox -e docs environment that runs sphinx-apidoc and builds HTML.
  • Extends PR validation workflow and .gitignore to 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.

Comment thread docs/conf.py Outdated
Comment thread docs/Makefile Outdated
Comment thread tox.ini Outdated
Comment thread docs/make.bat
…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
@hectorhdzg
Hector Hernandez (hectorhdzg) merged commit 8fab154 into microsoft:main Apr 20, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants