Description

serhiy-storchaka

opened on Jul 21, 2023

Issue body actions

Sphinx in the nitpick mode complains about standard C identifiers like "size_t", "LONG_MAX" and "errno". This can be solved individually by adding ! before the name, e.g. :c:data:`errno` or using literal text instead of semantic role, e.g. ``errno``. Although it does not solve complains about using types like size_t in function signature. Other way -- add them to the nitpick_ignore list in conf.py.

Linked PRs

• gh-106948: Add standard external names to nitpick_ignore #106949
• [3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) #107060
• [3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) #107061
• [3.12] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (GH-107062) #107154
• [3.11] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (#107062) #107157
• gh-106948: Add Doc/nitpick_ignore.yml config file #107278
• gh-106948: Update documentation nitpick_ignore for c:identifer domain #107295
• [3.12] gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH-107295) #107297
• [3.11] gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295) #107299
• gh-106948: Doc config ignores more standard C functions #107301

Reacted by Erlend E. Aasland

Activity

1. serhiy-storchaka

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Jul 21, 2023
2. serhiy-storchaka

   added 5 commits that reference this issue on Jul 21, 2023

   pythongh-106948: Add standard external names to nitpick_ignore

   9079a34

   gh-106948: Add standard external names to nitpick_ignore (GH-106949)

   f8b7fe2

   [3.12] pythongh-106948: Add standard external names to nitpick_ignore (…

   adb7c9b

   [3.11] pythongh-106948: Add standard external names to nitpick_ignore (…

   2c76f6a

   [3.12] pythongh-106948: Add standard external names to nitpick_ignore (…

   95e6108
3. serhiy-storchaka

   linked a pull request that will close this issuegh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls #107062on Jul 23, 2023
4. serhiy-storchaka

   removed a link to a pull requestgh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls #107062on Jul 23, 2023
5. ambv

   added 2 commits that reference this issue on Jul 23, 2023

   [3.11] gh-106948: Add standard external names to nitpick_ignore (GH-1…

   ec8718d

   [3.12] gh-106948: Add standard external names to nitpick_ignore (GH-1…

   456cf8b
6. erlend-aasland

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

   gh-106948: Docs: Disable links for C standard library functions, OS u…

   b447e19
7. miss-islington

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

   pythongh-106948: Docs: Disable links for C standard library functions…

   01d4280
8. erlend-aasland

   added 2 commits that reference this issue on Jul 23, 2023

   [3.12] gh-106948: Docs: Disable links for C standard library function…

   40a337f

   [3.11] gh-106948: Docs: Disable links for C standard library function…

   b3e600a
9. mementum

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

   pythongh-106948: Add standard external names to nitpick_ignore (pytho…

   28cbc89
10. 2 remaining items
11. vstinner

    added 5 commits that reference this issue on Jul 25, 2023

    pythongh-106948: Add Doc/nitpick_ignore.yml config file

    28b988b

    pythongh-106948: Add Doc/nitpick_ignore.yml config file

    133530d

    pythongh-106948: Add Doc/nitpick_ignore.yml config file

    3f82400

    pythongh-106948: Update documentation nitpick_ignore for c:identifer …

    ec25a36

    gh-106948: Update documentation nitpick_ignore for c:identifer domain (…

    b1de380
12. miss-islington

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

    pythongh-106948: Update documentation nitpick_ignore for c:identifer …

    01dff85
13. vstinner

    added 6 commits that reference this issue on Jul 26, 2023

    [3.12] gh-106948: Update documentation nitpick_ignore for c:identifer…

    0d2e131

    pythongh-106948: Update documentation nitpick_ignore for c:identifer …

    e442c80

    [3.11] gh-106948: Update documentation nitpick_ignore for c:identifer…

    bd0def0

    pythongh-106948: Doc config ignores more standard C functions

    c3ebffa

    pythongh-106948: Doc config ignores more standard C functions

    5a7aac8

    pythongh-106948: Doc config ignores more standard C functions

    8cc4083
14. jtcave

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

    pythongh-106948: Update documentation nitpick_ignore for c:identifer …

    3b876e6
15. serhiy-storchaka commented on Aug 16, 2023

    

    serhiy-storchaka

    on Aug 16, 2023

    MemberAuthor

    More actions

    It's all for now. Additional names can be added in separate issues or even without opening a special issue.

    Reacted by Hugo van Kemenade and Erlend E. Aasland
16. serhiy-storchaka

    closed this as completedon Aug 16, 2023

Issue actions