Skip to content

Conversation

@harryswift01
Copy link
Contributor

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

  • Added docs/ directory with Sphinx setup
  • Added Makefile and make.bat for building docs locally
  • Added docs/source/conf.py with configuration and extensions (autodoc, autosummary, napoleon, etc.)
  • Added docs/source/index.rst as documentation entry point
  • Removed old top-level Markdown docs (index.md, installation.md)

Add Documentation Build Support

  • Added .readthedocs.yaml to enable Read the Docs builds with Python 3.13
  • Configured RTD to install package with extra_requirements: docs
  • Updated GitHub Actions workflow to build docs during CI

Automatic API Documentation Support

  • Enabled autosummary_generate = True to allow auto API page generation
  • Added Sphinx extensions for improved docs experience (viewcode, copybutton, mathjax, intersphinx, nbsphinx, etc.)
  • Project is now ready to generate module and API docs via autosummary/autodoc

Impact

  • Documentation builds now work locally, in CI, and on Read the Docs
  • Foundation for expandable documentation and tutorials is established
  • Automatic API docs are supported once modules are added to a toctree (e.g., via api.rst)
  • Improves maintainability and accessibility for future contributors and users

@harryswift01 harryswift01 self-assigned this Dec 10, 2025
@harryswift01 harryswift01 linked an issue Dec 10, 2025 that may be closed by this pull request
@harryswift01 harryswift01 merged commit 2135cac into main Dec 10, 2025
11 checks passed
@harryswift01 harryswift01 deleted the 17-pre-configured-sphinx branch December 10, 2025 17:26
@harryswift01 harryswift01 linked an issue Dec 10, 2025 that may be closed by this pull request
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.

Auto API docs generation (sphinx-autodoc) Pre-configured Sphinx and Read the docs

2 participants