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, deprecate old explicit inventory specification #10128

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jakobandersen
Copy link
Contributor

Feature or Bugfix

  • Feature?

Purpose

Now that we have the external role for intersphinx (#9822) I think we should deprecate the old syntax.
This PR will warn by default, but there is a configuration variable to disable these warnings to aid in the transition.
As an initial suggestion, how about the following deprecation scheme?

  • The configuration variable to silence the warnings will be deprecated immediately and removed in v6 or v7 (i.e., 2023).
  • The actual old syntax will be removed in a major version or two afterwards.
    If I remember correctly then some projects (e.g., the Linux kernel) compiles with the version they ship, which can be rather old, so we need of research to figure out when exactly we can remove the syntax.

@tk0miya, any thoughts?

Detail

TODOs if this should go forward:

  • Name of config variable.
  • Documentation
  • CHANGES entry.

@tk0miya tk0miya changed the base branch from 4.x to 5.x May 22, 2022 12:54
@AA-Turner AA-Turner changed the base branch from 5.x to master October 16, 2022 15:21
@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.

None yet

2 participants