doc: fix intersphinx references #126
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
Fix the doc build warning: intersphinx inventory has moved: http://www.sphinx-doc.org/en/stable/objects.inv -> https://www.sphinx-doc.org/en/master/objects.inv
The object type for the "extensions" target has changed to "confval". It's a custom object type in the Sphinx documentation, and intersphinx is unable to reference it unless we define that locally as well. [1] Turn conf.py into an extension by adding the setup() function (yes, that's indeed possible), add the "confval" object type, and fix the extensions reference role to match that. [1] sphinx-doc/sphinx#5562 (comment)
See [1]. The role was added in Sphinx 4.4, so require that for the documentation build. [1] https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
|
Force pushed v2 with the issues addressed. |
Shame about the external syntax, but so be it. Looks good to me! |
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.
First, fix the intersphinx URL
Second, add 'confval' object type [1] to be able to reference objects of that type using intersphinx. (Yes, it's also possible to turn conf.py into an extension just by adding a setup() function.)
Third, fix the intersphinx references [2].
[1] sphinx-doc/sphinx#5562 (comment) [2] https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html