Skip to content

Docs use deprecated Sphinx .. index:: entries #97950

Description

@ezio-melotti

In #97921 (comment) @hugovk noticed that Sphinx has deprecated some of the .. index:: entry types:

module, keyword, operator, object, exception, statement, builtin
These all create two index entries. For example, module: hashlib creates the entries module; hashlib and hashlib; module. (These are Python-specific and therefore deprecated.)

Currently we are using some of those in the docs, so we have at least 3 options:

  • keep using them if it's a silent deprecation with no removal plans
  • reimplement them in pyspecific.py, if we want to keep use them (and if it's possible to reimplement them)
  • remove them and replace them with the non-deprecated ones

(cc @AA-Turner)

Linked PRs

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.11only security fixes3.12only security fixesdocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions