Repository navigation
Build the documentation without warnings - #64
Merged
Merged
Conversation
sphinx-build emitted two, both from settings sphinx-quickstart wrote and
nobody revisited:
WARNING: Invalid configuration value found: 'language = None'. Update
your configuration to a valid language code. Falling back to
'en' (English).
WARNING: html_static_path entry '_static' does not exist
language = None was the old way to say "not translated". Newer Sphinx
wants a language code and falls back to 'en', so say 'en'.
doc/source/_static has never existed, and is not ignored, it was simply
never created. There are no custom static files, so the honest fix is an
empty html_static_path rather than an empty directory that exists only
to stop the warning. The comment says how to put it back.
The output is unchanged. Building before and after gives identical file
lists, and the only file that differs at all is
.doctrees/environment.pickle, which is sphinx's own build cache and
records the config. Every html, css and js file is byte identical, and
_static in the output still has alabaster.css and friends, because those
come from the theme rather than from html_static_path.
No test run: nothing in the test suite or in pyproject.toml refers to
doc/.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or 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
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-buildemitted two warnings, both from settingssphinx-quickstartwrote and nobody revisited since:
language = Nonewas the old way to say "not translated". Newer Sphinx wantsa language code and falls back to
'en'anyway, so this says'en'.doc/source/_statichas never existed and is not ignored — it was simplynever created. There are no custom static files, so this empties
html_static_pathrather than adding an empty directory whose only purposewould be to stop the warning. A comment says how to put it back if custom CSS
is ever wanted.
The output is unchanged
Building before and after gives identical file lists, and the only file that
differs at all is
.doctrees/environment.pickle, which is Sphinx's own buildcache and records the config. Every html, css and js file is byte identical.
_staticin the output still containsalabaster.cssand the rest, sincethose come from the theme rather than from
html_static_path.sphinx-buildnow reportsbuild succeeded.with no warnings.Nothing in the test suite or in
pyproject.tomlrefers todoc/, and Sphinxis not a dependency of the package, so this cannot affect the analysis code.