Draft mode that skips (potentially) expensive parts of the build process #1836
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 is awesome! Could we add a |
When passing `draft=true` to `makedocs` a draft version of the documentation is built. Draft mode skips potentially expensive parts of the building process and can be useful to get faster feedback when writing documentation. Draft mode currently skips doctests, `@example`, `@repl`, `@eval`, and `@setup` blocks. Draft mode can be disabled (or enabled) on a per-page basis by setting `Draft = true` in an `@meta` block.
|
Added tests, and also disabled doctests in draft mode. |
fredrikekre
commented
Jun 3, 2022
KristofferC
reviewed
Jun 3, 2022
Co-authored-by: Kristoffer Carlsson <kcarlsson89@gmail.com>
fredrikekre
added a commit
that referenced
this pull request
Jun 3, 2022
…ess (#1836) When passing `draft=true` to `makedocs` a draft version of the documentation is built. Draft mode skips potentially expensive parts of the building process and can be useful to get faster feedback when writing documentation. Draft mode currently skips doctests, `at-example`, `at-repl`, `at-eval`, and `at-setup` blocks. Draft mode can be disabled (or enabled) on a per-page basis by setting `Draft = true` in an `at-meta` block. (cherry picked from commit 051bb4a)
fredrikekre
added a commit
that referenced
this pull request
Jun 5, 2022
…ess (#1836) When passing `draft=true` to `makedocs` a draft version of the documentation is built. Draft mode skips potentially expensive parts of the building process and can be useful to get faster feedback when writing documentation. Draft mode currently skips doctests, `at-example`, `at-repl`, `at-eval`, and `at-setup` blocks. Draft mode can be disabled (or enabled) on a per-page basis by setting `Draft = true` in an `at-meta` block. (cherry picked from commit 051bb4a)
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.
When passing
draft=truetomakedocsa draft version of thedocumentation is built. Draft mode skips potentially expensive parts of
the building process and can be useful to get faster feedback when
writing documentation. Draft mode currently skips
@example,@repl,@eval, and@setupblocks. Draft mode can be disabled (or enabled) ona per-page basis by setting
Draft = truein an@metablock.