Skip to content

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.

@jakobandersen jakobandersen force-pushed the intersphinx_deprecate_explicit branch from 3a43fab to 048af45 Compare January 22, 2022 13:37
@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
@AA-Turner
Copy link
Member

Currently I don't think this is worth the disruption, but we could revisit it later.

A

@AA-Turner AA-Turner closed this Oct 6, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants