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

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

Open
ezio-melotti opened this issue Oct 6, 2022 · 1 comment
Open

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

ezio-melotti opened this issue Oct 6, 2022 · 1 comment
Labels
3.10 3.11 3.12 docs Documentation in the Doc dir easy sprint type-bug An unexpected behavior, bug, or error

Comments

@ezio-melotti
Copy link
Member

ezio-melotti commented Oct 6, 2022

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)

@ezio-melotti ezio-melotti added type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir sprint labels Oct 6, 2022
@AA-Turner
Copy link
Member

AA-Turner commented Oct 13, 2022

I want to remove them eventually, I think the best option may be (3) as index entry types are quite hard to patch into Sphinx.

A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.10 3.11 3.12 docs Documentation in the Doc dir easy sprint type-bug An unexpected behavior, bug, or error
Projects
Status: Todo
Development

No branches or pull requests

3 participants