docs: specify sphinx dirhtml builder, use references instead of absolutes #6612
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
With the requirement of a configuration file, the default builder of `dirhtml` that RTD used to use is no longer specified. This leads to URLs ending in `.html` now, which breaks other exisitng references. Refs: psf#6603 Refs: https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-builder Refs: https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.dirhtml.DirectoryHTMLBuilder Signed-off-by: Mike Fiedler <[email protected]>
|
Probably should revert #6604 as well |
|
Please do include a revert of that PR in here. I didn't get a chance to object to it |
|
Revert added |
Any development links will now refer back to the generated docs. Signed-off-by: Mike Fiedler <[email protected]>
miketheman
changed the title
|
Added references instead of absolutes, so these shouldn't ever need to be changed despite the builder chosen. |
Signed-off-by: Mike Fiedler <[email protected]>
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.
With the requirement of a configuration file, the default builder of
dirhtmlthat RTD used to use is no longer specified. This leads to URLs ending in.htmlnow, whichbreaks other exisitng references.
Refs: #6603
Refs: https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-builder
Refs: https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.dirhtml.DirectoryHTMLBuilder