Issue #373: Fix sphinx-build warnings and errors when using new versions of Sphinx #423
Conversation
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
esabol
commented
Jul 6, 2025
…new versions of Sphinx. Also, tweaked GitHub Actions docs.yml workflow to be more robust and free of warnings.
esabol
force-pushed
the
fix-some-sphinx-docs-warnings
branch
from
8e8e62f to
ef2a926
Compare
Member
Author
|
Latest commit (which has been squashed with the initial commit) was successfully tested with Sphinx 7.2.6 on Ubuntu 24.04 and with Sphinx 1.8.5 on Ubuntu 20.04. No errors or warnings with either version! Woo hoo! Since there are no changes to the source code, I'm going to merge this once the CI pipeline passes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 PR addresses issue #373 by fixing a number of warnings and errors emitted by recent versions of Sphinx when building the HTML documentation for gearmand.
It has been successfully tested with Sphinx 7.2.6 on Ubuntu 24.04 and with Sphinx 1.8.5 on Ubuntu 20.04.