fix Sphinx warning #393
Merged
fix Sphinx warning #393
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
Sphinx issues a warning, when the `html_static_path` contains paths with underscores. `tox -e docs` resulted in the following warning: "WARNING: html_static_path entry '_static' does not exist" As `_static` is the default value for `html_static_path` there is no need to configure it explicitly. Also see readthedocs/readthedocs.org#1776 An alternative approach would have been to set the path to e.g. `static`.
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.
Sphinx issues a warning, when the
html_static_pathcontains paths withunderscores.
tox -e docsresulted in the following warning:"WARNING: html_static_path entry '_static' does not exist"
As
_staticis the default value forhtml_static_paththere is noneed to configure it explicitly.
Also see readthedocs/readthedocs.org#1776
An alternative approach would have been to set the path to e.g.
static.