This repository has been archived by the owner on Jan 15, 2024. It is now read-only.
[BUGFIX]Disable nbsphinx plugin execute code chunks #1197
Merged
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
Codecov Report
@@ Coverage Diff @@
## master #1197 +/- ##
==========================================
+ Coverage 87.32% 87.42% +0.09%
==========================================
Files 81 81
Lines 7345 7345
==========================================
+ Hits 6414 6421 +7
+ Misses 931 924 -7
|
|
Job PR-1197/1 is complete. |
|
This pull request is complete and ready for merge |
chenw23
pushed a commit
to chenw23/gluon-nlp
that referenced
this pull request
Apr 15, 2020
Now adopts the great new enhancements from dmlc#1191 , dmlc#1192 , dmlc#1193 , dmlc#1194 , dmlc#1195 , dmlc#1196 , dmlc#1197 , dmlc#1198 and dmlc#1120 . The pull requests above fixed various errors in the previous make docs command and added new switch options. Now the commands mentioned in this documentation are strictly error-free.
chenw23
pushed a commit
to chenw23/gluon-nlp
that referenced
this pull request
Apr 15, 2020
Now adopts the great new enhancements from dmlc#1191 , dmlc#1192 , dmlc#1193 , dmlc#1195 , dmlc#1196 , dmlc#1197 , dmlc#1198 and dmlc#1200 . The pull requests above fixed various errors in the previous make docs command and added new switch options. Now the commands mentioned in this documentation are strictly error-free.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
There are cases that we don't want to compute the results for the
pythoncode chunks in the.mdfiles. So I added a configuration for disabling execute code chunks when converting.mdfiles to.ipynbfiles. See #1191 #1192However, the
nbsphinxplugin ofsphinx, which is in charge of reading.ipynbfiles forsphinx, automatically executes all chunks without output, which is opposite to what we want. So this pull request turns this feature off.Turning this off won't have any side effect because all the
ipynbfiles in this project resides in thedocs/examples/path and they are all converted frommdfiles. So even if we want to compute the results, all the computation should be done inmd2ipynb.pyfile andnbsphinxwill still not compute code chunks in the normal process.Checklist
Essentials
Changes
Comments
cc @dmlc/gluon-nlp-team