-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Can't use intersphinx with Sphinx's documentation settings #5562
Milestone
Comments
It is custom object type defined in our doc: Lines 140 to 142 in a4cce3e
You can refer it if you'll also define it on your project. |
jnikula
added a commit
to jnikula/hawkmoth
that referenced
this issue
Jan 20, 2023
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
jnikula
added a commit
to jnikula/hawkmoth
that referenced
this issue
Jan 21, 2023
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)
jnikula
added a commit
to jnikula/hawkmoth
that referenced
this issue
Jan 22, 2023
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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem
Procedure to reproduce the problem
Error logs / results
Expected results
It should generate a URL to the proper Sphinx docs
Debugging
I tracked this down to the fact that my Sphinx run doesn't know about the
std:confval
reference type. I have it in the intersphinx data:But when I create the list of possible targets from my list of domains, it isn't there:
Code
I believe the issue is the logic here, which takes into account the installed Domains, but not the known labels in the
intersphinx_inventory
:sphinx/sphinx/ext/intersphinx.py
Lines 301 to 303 in c584b71
The text was updated successfully, but these errors were encountered: