Skip to content

Move apidoc generation to doc building script - #897

Draft
AVHopp wants to merge 2 commits into
docs/fix_doc_references_newfrom
docs/refactor-apidoc_new
Draft

Move apidoc generation to doc building script#897
AVHopp wants to merge 2 commits into
docs/fix_doc_references_newfrom
docs/refactor-apidoc_new

Conversation

@AVHopp

@AVHopp AVHopp commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

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 CLIGive Feedback 💬

Copilot AI lite review requested due to automatic review settings August 18, 2026 15:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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() to docs/scripts/build_documentation.py and invoked it during the docs build flow.
  • Removed the legacy in-conf.py apidoc “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.

Comment thread docs/scripts/build_documentation.py
Comment thread docs/scripts/build_documentation.py
@AVHopp
AVHopp force-pushed the docs/refactor-apidoc_new branch from dd0f2e2 to acf83ea Compare August 19, 2026 07:08
@AVHopp
AVHopp force-pushed the docs/refactor-apidoc_new branch from acf83ea to 24125fa Compare August 19, 2026 07:12
@AVHopp
AVHopp marked this pull request as draft August 20, 2026 08:55
@AVHopp
AVHopp marked this pull request as ready for review August 20, 2026 10:46
@AVHopp
AVHopp marked this pull request as draft August 20, 2026 13:31
@AVHopp AVHopp self-assigned this Aug 20, 2026
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