Repository navigation
Fix documentation build warnings - #507
Merged
savannahostrowski merged 5 commits intoNov 9, 2026
Merged
Conversation
hugovk
approved these changes
Nov 7, 2026
hugovk
left a comment
hugovk
left a comment
Member
There was a problem hiding this comment.
Thanks!
We could (here or in a followup) build the docs in CI to prevent new warnings being introduced.
StanFromIreland
approved these changes
Nov 9, 2026
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.
This fixes the warnings from tox -e doc by making 11 changelog heading underlines long enough and removing the unused _static path from the Sphinx config.
AFAICT, that setting has been there since the docs were added in 2017, but we’ve never tracked any files in doc/_static. Sphinx still creates the output _static directory for the theme’s CSS and JavaScript.