This repository has been archived by the owner on Jan 15, 2024. It is now read-only.
Fix and test building documentation is possible without running all notebooks #420
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
leezu
added
bug
leezu
commented
Nov 23, 2018
| @@ -241,7 +241,7 @@ print(sample_tgt_seq) | |||
| ``` | |||
|
|
|||
| If you'd like to train your own transformer models, you may find the training scripts in our | |||
| [model zoo](../../model_zoo/machine_translation/index.rst). | |||
| [model zoo](../../../scripts/machine_translation/index.rst). | |||
There was a problem hiding this comment.
Without this change we run into readthedocs/recommonmark#93
There was a problem hiding this comment.
But it is not valid for the CI build with publication /var/lib/jenkins/workspace/gluon-nlp-docs/docs/examples/machine_translation/transformer.ipynb.rst:link outside of source directory: '../scripts/machine_translation/index.rst'
leezu
force-pushed
the
fixlocaldocbuild
branch
2 times, most recently
from
8cd4386 to
9993143
Compare
Codecov Report
@@ Coverage Diff @@
## master #420 +/- ##
===========================================
- Coverage 84.25% 69.61% -14.65%
===========================================
Files 94 134 +40
Lines 8313 11833 +3520
===========================================
+ Hits 7004 8237 +1233
- Misses 1309 3596 +2287
|
leezu
force-pushed
the
fixlocaldocbuild
branch
2 times, most recently
from
ea751bf to
d4c48ef
Compare
CI currently only tests that documentation can be built after all notebooks are run and converted from .md to .ipynb format. Running all notebooks takes some time. This CI step makes sure, that the documentation can also be built without converting the notebooks first.
leezu
force-pushed
the
fixlocaldocbuild
branch
from
d4c48ef to
dfd581b
Compare
eric-haibin-lin
approved these changes
Dec 18, 2018
|
I'm not yet sure how to get this to work. https://github.com/dmlc/gluon-nlp/pull/420/files#diff-be3f0c715a65e953102c0e00f934c72bR244 fixes the issue in the local mode, but breaks on CI. (I didn't look into this again.) |
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
CI currently only tests that documentation can be built after all notebooks are
run and converted from .md to .ipynb format. Running all notebooks takes some
time. This CI step makes sure, that the documentation can also be built without
converting the notebooks first.
Checklist
Essentials
Changes
Comments
Fixes #419