build-docs-preview.py for end-to-end local docs build#1854
Merged
Conversation
mpharrigan
added
the
devops
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a new script, dev_tools/build-docs-preview.py, to automate the local build and preview of Qualtran documentation. The script orchestrates several steps, including cleaning the build environment, executing notebooks, and generating reference documentation. Feedback from the review suggests improving cross-platform compatibility by handling Windows-specific build commands (make.bat) and expanding exception handling to catch FileNotFoundError when external tools like git or make are missing from the system path.
Open
… command execution flow
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
1 participant
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.
The multistep doc build
We're at a point now where each of these can be run in an "iterative" mode where it only generates changed content for fast iteration (re-building the docs in ~seconds) at the expense of potentially out-of-date side navbar. Re-running all the notebooks and doing a clean sphinx build takes a few minutes in total.