Skip to content

Update Sphinx configuration to modern standards and add CI documentation build#23

Merged
csett86 merged 4 commits into
mainfrom
copilot/update-docs-sphinx-standards
Jan 17, 2026
Merged

Update Sphinx configuration to modern standards and add CI documentation build#23
csett86 merged 4 commits into
mainfrom
copilot/update-docs-sphinx-standards

Conversation

Copilot AI commented Jan 17, 2026

Copy link
Copy Markdown

Sphinx documentation was failing to build cleanly due to deprecated API usage and configuration issues.

Changes

Configuration modernization (docs/conf.py)

  • Replace deprecated master_doc with root_doc
  • Convert source_suffix from string to dictionary format
  • Remove deprecated html_theme_path call (unnecessary with modern sphinx_rtd_theme)
  • Replace manual Mock class with autodoc_mock_imports (Sphinx's native mocking mechanism)
  • Suppress autodoc.import_object warnings for dependencies that can't be imported during doc build

RST formatting (docs/index.rst)

  • Fix title underline length mismatch

CI/CD integration (.github/workflows/tests.yml)

  • Add docs job to build documentation on every PR
  • Install Sphinx and sphinx_rtd_theme dependencies
  • Build HTML documentation and upload as artifact
  • Include docs job in failure notification system

Result

Documentation now builds cleanly with zero warnings on Sphinx 9.1.0:

cd docs && make html
# Running Sphinx v9.1.0
# ...
# build succeeded.

The documentation build is now automated in the CI pipeline and will run on every pull request, ensuring documentation changes don't break the build process.

Original prompt

Update docs to current sphinx standards and make it work again


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: csett86 <1392875+csett86@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation to current Sphinx standards Update Sphinx configuration to modern standards Jan 17, 2026
Copilot AI requested a review from csett86 January 17, 2026 13:16
@csett86

csett86 commented Jan 17, 2026

Copy link
Copy Markdown
Owner

@copilot In addition, build the documentation on every PR in github actions tests.yml

Co-authored-by: csett86 <1392875+csett86@users.noreply.github.com>

Copilot AI commented Jan 17, 2026

Copy link
Copy Markdown
Author

@copilot In addition, build the documentation on every PR in github actions tests.yml

Added a docs job to .github/workflows/tests.yml that builds the documentation on every PR. The job installs Sphinx and sphinx_rtd_theme, builds the HTML documentation, and uploads it as an artifact. The documentation build is now part of the CI pipeline alongside tests and package builds. (commit b4680f3)

Co-authored-by: csett86 <1392875+csett86@users.noreply.github.com>
Copilot AI changed the title Update Sphinx configuration to modern standards Update Sphinx configuration to modern standards and add CI documentation build Jan 17, 2026
Copilot AI requested a review from csett86 January 17, 2026 13:23
@csett86 csett86 marked this pull request as ready for review January 17, 2026 13:46
@csett86 csett86 merged commit e3b714c into main Jan 17, 2026
11 checks passed
@csett86 csett86 deleted the copilot/update-docs-sphinx-standards branch January 17, 2026 14:23
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.

2 participants