Doc system notebook execution: WriteIfDifferent. Misc doc fixes#1648
Merged
mpharrigan merged 4 commits intoquantumlib:mainfrom May 29, 2025
Merged
Doc system notebook execution: WriteIfDifferent. Misc doc fixes#1648mpharrigan merged 4 commits intoquantumlib:mainfrom
mpharrigan merged 4 commits intoquantumlib:mainfrom
Conversation
NoureldinYosri
approved these changes
May 15, 2025
wjhuggins
pushed a commit
to wjhuggins/Qualtran
that referenced
this pull request
May 31, 2025
…tumlib#1648) Feature: `jupyter_autogen.py` will only re-write `*.ipynb` files if there's been a change. The tool to execute the notebooks is already to set up to only re-execute notebooks if they're out of date. But every time you re-run the first autogen script, it will re-up the modification date and everything will always be re-evaluated, which is expensive. Misc fixes - Use a distinct extension for `autotoc.rst.inc`, so sphinx doesn't treat it as a page and emit warnings about it - include missing TOC entries for notebooks - fix flaky notebook assertion by using more idiomatic sympy methods - grammar and arg docstring fixes in gf_poly
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
2 participants
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.
Feature:
jupyter_autogen.pywill only re-write*.ipynbfiles if there's been a change.The tool to execute the notebooks is already to set up to only re-execute notebooks if they're out of date. But every time you re-run the first autogen script, it will re-up the modification date and everything will always be re-evaluated, which is expensive.
Misc fixes
autotoc.rst.inc, so sphinx doesn't treat it as a page and emit warnings about it