Update Sphinx configuration to modern standards and add CI documentation build#23
Merged
Merged
Conversation
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
csett86
approved these changes
Jan 17, 2026
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>
Author
Added a |
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
csett86
approved these changes
Jan 17, 2026
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.
Sphinx documentation was failing to build cleanly due to deprecated API usage and configuration issues.
Changes
Configuration modernization (
docs/conf.py)master_docwithroot_docsource_suffixfrom string to dictionary formathtml_theme_pathcall (unnecessary with modern sphinx_rtd_theme)Mockclass withautodoc_mock_imports(Sphinx's native mocking mechanism)autodoc.import_objectwarnings for dependencies that can't be imported during doc buildRST formatting (
docs/index.rst)CI/CD integration (
.github/workflows/tests.yml)docsjob to build documentation on every PRResult
Documentation now builds cleanly with zero warnings on Sphinx 9.1.0:
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
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.