Repository navigation
Conversation
Contributor
|
Great! :) |
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.
explanations/docs.ipynbalready says thatexec_all: truein a notebook's frontmatter makes nbdev execute all cells when rendering docs, but nothing currently reads the flag.exec_show_docsruns only exports, imports,show_doccalls and cells marked#| exec_doc, and skips a notebook with no exports orshow_doccalls altogether.After this change, with
exec_allset (either in frontmatter or under[tool.nbdev]),exec_show_docsruns every code cell thatnbdev-testwould run:eval: false, the notebook'sevaldefault,tst_flagsand theskip-executiontag are honoured, andskip_showdocstill wins. Execution happens beforerm_exportandhide_, so cells run with their full source.Will be useful for a project that strips or clears outputs before committing (#1664) but still wants those outputs in the rendered docs.