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

[WIP] intersphinx, allow an inventory to be a self ref #10127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jakobandersen
Copy link
Contributor

@jakobandersen jakobandersen commented Jan 22, 2022

Feature or Bugfix

  • Feature

Purpose

A resolution for #9169 where a new config variable intersphinx_self_mapping can be used to specify an inventory name which will make corresponding :external+thatName:domain:role: references to fall back as if the user wrote :domain:role:.
This is useful for Python projects where a docstring can be inherited from an external project. That external project would need to write :external: references in those docstrings and use this self-mapping mechanism.

TODOs:

  • Name of config variable?
  • Does it need an env_version bump?
  • Documentation
  • CHANGES entry

Relates

Fixes #9169

@tk0miya
Copy link
Member

tk0miya commented Jan 23, 2022

I can understand the case. But I feel very strange to annotate "local" reference as an "external" reference... I'm not sure this should be implemented as a built-in feature.

@jakobandersen
Copy link
Contributor Author

I can understand the case. But I feel very strange to annotate "local" reference as an "external" reference... I'm not sure this should be implemented as a built-in feature.

It is indeed a bit of a hax. Ideally the root of the problem, that docstrings are copied from external projects, should be addressed directly.

@tk0miya tk0miya changed the base branch from 4.x to 5.x May 22, 2022 12:55
@AA-Turner AA-Turner changed the base branch from 5.x to master October 16, 2022 15:22
@AA-Turner AA-Turner added this to the some future version milestone Apr 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Resolve intersphinx to own project as current build
3 participants