DOC: add option for skipping execution of code blocks #39360
Closed
Conversation
This file contains 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
This should make documentation builds faster for people who aren't working on the code samples.
|
Speeds up full build by 36% in wall clock time. Ran these in GitHub Codespaces. |
| @@ -302,6 +306,12 @@ def main(): | |||
| argparser.add_argument( | |||
| "--no-api", default=False, help="omit api and autosummary", action="store_true" | |||
| ) | |||
| argparser.add_argument( | |||
| "--no-ipython", | |||
| default=False, | |||
There was a problem hiding this comment.
is default needed with action="store_true"?
There was a problem hiding this comment.
Not sure; I just copied from --no-api above.
There was a problem hiding this comment.
Yeah I think Marco is correct - https://docs.python.org/3/library/argparse.html#action
| @@ -595,6 +595,9 @@ reducing the turn-around time for checking your changes. | |||
| python make.py clean | |||
| python make.py --no-api | |||
|
|
|||
| # skip executing the code blocks | |||
There was a problem hiding this comment.
Worth noting why someone might do this - slight performance improvements :)
|
status here? |
|
On second thought, not sure it's worth the added complexity for the narrow use case. If someone disagrees, happy to reopen and fix. Thanks for the reviews! |
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.
Came up as an idea at the documentation meeting (#39183). This should make documentation builds faster for people who aren't working on the code samples.
Very open to alternatives names to
--no-ipython.closes #xxxxwhatsnew entry