Description

ezio-melotti

opened on Oct 6, 2022

Issue body actions

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

• GH-97950: Use new-style index directive ('module') #103996
• GH-97950: Allow translation of index directive content #104000
• [3.11] GH-97950: Allow translation of index directive content (GH-104000) #104151
• GH-97950: Use new-style index directive ('keyword') #104153
• [3.11] GH-97950: Use new-style index directive ('module') (GH-103996) #104154
• [3.11] GH-97950: Use new-style index directive ('keyword') (GH-104153) #104155
• GH-97950: Use new-style index directive ('operator') #104156
• [3.11] GH-97950: Use new-style index directive ('operator') (GH-104156) #104157
• GH-97950: Use new-style index directive ('object') #104158
• [3.11] GH-97950: Use new-style index directive ('object') (GH-104158) #104159
• GH-97950: Use new-style index directive ('exception') #104160
• [3.11] GH-97950: Use new-style index directive ('exception') (GH-104160) #104161
• GH-97950: Use new-style index directive ('statement') #104162
• [3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) #104163
• GH-97950: Use new-style index directive ('builtin') #104164
• [3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) #104221
• [3.11] GH-97950: Fix old-style index directive in Doc/library/imp.rst #107246

Activity

1. ezio-melotti

   added

   type-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   sprint

   on Oct 6, 2022
2. ezio-melotti

   added this to Sprinton Oct 6, 2022
3. ezio-melotti

   moved this to Todo in Sprinton Oct 6, 2022
4. AA-Turner commented on Oct 13, 2022

   

   AA-Turner

   on Oct 13, 2022

   Member

   More actions

   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

   Reacted by Hugo van Kemenade and Furkan Onder
5. AA-Turner

   added

   3.11only security fixesonly security fixes

   3.10 (EOL)end of lifeend of life

   3.12only security fixesonly security fixes

   on Oct 13, 2022
6. hugovk

   added

   easy

   on Nov 10, 2022
7. mmmarcos commented on Jan 26, 2023

   

   mmmarcos

   on Jan 26, 2023

   More actions

   In principle, these deprecated index-types can all be replaced with the more generic pair index-type. However, this has already been done/attempted in #18004 and it was not merged because of a Sphinx issue : the python index-types (module, ...) are automatically translated in the index page while this is not the case when using pair: module; ...: (see sphinx-doc/sphinx#6970 (comment)).

   Reacted by Ezio Melotti
8. arhadthedev

   added

   3.13only security fixesonly security fixes

   3.11only security fixesonly security fixes

   and removed

   3.11only security fixesonly security fixes

   3.10 (EOL)end of lifeend of life

   on Apr 29, 2023
9. 30 remaining items
10. hugovk

    added a commit that references this issue on May 4, 2023

    [3.11] GH-97950: Use new-style index directive ('exception') (GH-104160…

    99e6314
11. miss-islington

    added a commit that references this issue on May 4, 2023

    pythonGH-97950: Use new-style index directive ('statement') (pythonGH…

    cb7222d
12. hugovk

    added a commit that references this issue on May 4, 2023

    [3.11] GH-97950: Use new-style index directive ('statement') (GH-104162…

    6a970ae
13. AA-Turner

    removed

    easy

    on May 4, 2023
14. hugovk

    added a commit that references this issue on May 6, 2023

    GH-97950: Use new-style index directive ('builtin') (#104164)

    f508800
15. miss-islington

    added a commit that references this issue on May 6, 2023

    pythonGH-97950: Use new-style index directive ('builtin') (pythonGH-1…

    f6a4214
16. hugovk

    added a commit that references this issue on May 6, 2023

    [3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) (

    4b11af0
17. hugovk

    added

    3.11only security fixesonly security fixes

    and removed

    3.11only security fixesonly security fixes

    3.13only security fixesonly security fixes

    on May 6, 2023
18. hugovk commented on May 6, 2023

    

    hugovk

    on May 6, 2023

    Member

    More actions

    @AA-Turner Thanks for the PRs, all merged and backported to 3.11! Are we good to close this now or is there more to come?
19. AA-Turner commented on May 6, 2023

    

    AA-Turner

    on May 6, 2023

    Member

    More actions

    All done I believe, thanks all!

    A

    Reacted by Hugo van Kemenade, Ezio Melotti and Marcos Medrano
20. AA-Turner

    closed this as completedon May 6, 2023
21. jbower-fb

    added a commit that references this issue on May 8, 2023

    pythonGH-97950: Use new-style index directive ('builtin') (python#104164

    cf8ee0b
22. hugovk

    added a commit that references this issue on Jul 26, 2023

    [3.11] GH-97950: Fix old-style index directive in Doc/library/imp.rst (…

    9fa44d7

Issue actions