Move apidoc generation to doc building script - #891
Closed
AVHopp wants to merge 1 commit into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR streamlines the documentation build by moving sphinx-apidoc execution out of the Sphinx conf.py (which is imported as part of any Sphinx run) into the dedicated documentation build script.
Changes:
- Added an internal
_run_apidoc()helper todocs/scripts/build_documentation.pyand invoked it beforesphinx-build. - Removed the legacy “run sphinx-apidoc inside
docs/conf.py” block (and related imports), reducing side effects during Sphinx configuration import.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/scripts/build_documentation.py | Adds and runs a sphinx-apidoc generation step as part of the scripted docs build flow. |
| docs/conf.py | Removes the old apidoc-on-import logic to keep Sphinx configuration focused on configuration only. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+115
to
+116
| # Generate the API reference stubs via sphinx-apidoc | ||
| _run_apidoc() |
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 08:45
7dd762c to
317f6dc
Compare
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 10:45
317f6dc to
17c208d
Compare
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 11:13
17c208d to
203d2cc
Compare
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 11:30
203d2cc to
361f033
Compare
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 11:45
361f033 to
5b5fe2c
Compare
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 11:59
5b5fe2c to
580dd00
Compare
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 13:48
580dd00 to
dfe90ce
Compare
AdrianSosic
approved these changes
Aug 18, 2026
AVHopp
force-pushed
the
docs/refactor-apidoc
branch
from
August 18, 2026 14:42
dfe90ce to
dd0f2e2
Compare
Collaborator
Author
|
Closing due to weird stuff happening with stacked PR |
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 💬