Build fixes and cleanup for Sphinx version 4 #722
Merged
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
Limit the depth of cloning to one, as we're just interested in the latest version of all files during deployment.
Follow most "broken" and "redirect" hints given by make linkcheck, where it makes sense. * https:// redirects * go.dev domain redirects from older golang sites * datatracker.ietf.org (from tools.ietf.org) * www.foo.tld versus foo.tld redirects * Cloudron demo site * pypi.org redirect * ind.ie served by small-tech.org (for pulse-swift) * github.com/codabrink rename * github.com/jastBytes rename * removed salt-syncthing (dead on GitHub) * removed susestudio.com (gone, project not migrated) * other small fixes
acolomb
changed the title
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.
This started as an exercise to get rid of warnings during the documentation build. Turns out the main cause for over 70 warnings is currently sphinx-doc/sphinx#10112 on Sphinx 4.4.0. A hot-fix release appears to be imminent to make them opt-in. Fixed the one legitimate warning from
extlinksand some other linking issues along the way.To possibly speed up the build / deployment process, limit the cloning depth for the docs-pre-rendered repo to 1, as everything else gets discarded anyway.