This repository has been archived by the owner on Jan 15, 2024. It is now read-only.
Fix sphinx docs #92
Merged
Fix sphinx docs #92
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
`log` (used in beam_search_generator.rst) is not a valid lexer. `bash` is for shell scripts. We are presenting interactive sessions and should use `console`.
This is required: https://media.readthedocs.org/pdf/nbsphinx/latest/nbsphinx.pdf Otherwise we will get a lot of warnings if the environment contains ipynb_checkpoints..
This may not be exhaustive yet, but are the requirements needed on my machine to build the documentation.
'docs' depends on .zip archives created in the 'release' step
Sphinx won't warn about orphan elements not being included in the TOC.
leezu
force-pushed
the
fixdocs
branch
2 times, most recently
from
c90c024 to
ed25e4b
Compare
|
Job PR-92/5 is complete. |
szha
approved these changes
Apr 28, 2018
cgraywang
pushed a commit
to cgraywang/gluon-nlp-1
that referenced
this pull request
May 2, 2018
* Fix pygments lexers `log` (used in beam_search_generator.rst) is not a valid lexer. `bash` is for shell scripts. We are presenting interactive sessions and should use `console`. * Add .ipynb_checkpoints to sphinx exclude_patterns This is required: https://media.readthedocs.org/pdf/nbsphinx/latest/nbsphinx.pdf Otherwise we will get a lot of warnings if the environment contains ipynb_checkpoints.. * Declare development requirements This may not be exhaustive yet, but are the requirements needed on my machine to build the documentation. * Make CI deploy stage fail if there are any Sphinx warnings * Add 'release' dependency to 'docs' in Makefile 'docs' depends on .zip archives created in the 'release' step * Declare word embedding evaluation extended_results.ipynb as orphan Sphinx won't warn about orphan elements not being included in the TOC. * Fix docstrings causing sphinx warnings * Install ipython from conda-forge Workaround ContinuumIO/anaconda-issues#1430
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
This PR fixes all documentation that causes warnings when building the documentation. It also switches the CI to only pass if the documentation doesn't cause warnings.
The rationale is to make sure that we never create any errors in our documentation by accident (broken links, missing files, etc.).