Skip to content
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

C domain: References generated by types in function signatures don't use intersphinx #8341

Closed
eric-wieser opened this issue Oct 26, 2020 · 1 comment · Fixed by #8682
Closed
Assignees

Comments

@eric-wieser
Copy link
Contributor

Describe the bug
Over in numpy/numpy#16370, we're getting warnings about missing references to C identifiers even though we know they exist in projects in our intersphinx

To Reproduce
Create an RST file with

.. c:function:: PyObject* MyFunction(PyObject* op)
   Some description

put the following in conf.py

extensions = ['sphinx.ext.intersphinx']
intersphinx_mapping = {
    'python': ('https://docs.python.org/dev', None),
}

Build the sphinx docs with reference warnings enabled. The output log will contain

c:identifier reference target not found: PyObject

which is strange, because the https://docs.python.org/dev/objects.inv definitely contains an entry for PyObject.

Expected behavior
No warning

Your project
Link to your sphinx project, or attach zipped small project sample.

Screenshots
If applicable, add screenshots to help explain your problem.

Environment info

  • Python version: 3.8
  • Sphinx version: 3.2.1
  • Sphinx extensions: sphinx.ext.intersphinx
jakobandersen added a commit to jakobandersen/sphinx that referenced this issue Jan 11, 2021
Add 'identifer' to all and 'type' to types.

Fixes sphinx-doc#8341
jakobandersen added a commit to jakobandersen/sphinx that referenced this issue Jan 11, 2021
Add 'identifer' to all and 'type' to types.

Fixes sphinx-doc#8341
@jakobandersen
Copy link
Contributor

Fixed in 3.x (to become v3.5). The fix is only on the client side so you can simply recompile your own project with the new version.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants