Move apidoc generation to doc building script - #897
Draft
AVHopp wants to merge 2 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Moves the sphinx-apidoc API-stub generation out of docs/conf.py and into the documentation build script, aiming to streamline Sphinx config and keep doc-generation steps in one place.
Changes:
- Added
_run_apidoc()todocs/scripts/build_documentation.pyand invoked it during the docs build flow. - Removed the legacy in-
conf.pyapidoc “hack” (including defensive guards and filesystem cleanup).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/scripts/build_documentation.py |
Adds a new _run_apidoc() step and calls it as part of the documentation build pipeline. |
docs/conf.py |
Removes the previous sphinx-apidoc execution block and related imports/guarding logic. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
AVHopp
force-pushed
the
docs/refactor-apidoc_new
branch
from
August 19, 2026 07:08
dd0f2e2 to
acf83ea
Compare
AVHopp
force-pushed
the
docs/refactor-apidoc_new
branch
from
August 19, 2026 07:12
acf83ea to
24125fa
Compare
AVHopp
marked this pull request as draft
August 20, 2026 08:55
AVHopp
marked this pull request as ready for review
August 20, 2026 10:46
AVHopp
marked this pull request as draft
August 20, 2026 13:31
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.
This is a small PR, removing an old defensive guard and moving a part of the doc generation to another file to streamline the files a bit.
Stack created with GitHub Stacks CLI • Give Feedback 💬