Docs: add standard external names to nitpick_ignore #106948

serhiy-storchaka · 2023-07-21T08:50:20Z

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

The text was updated successfully, but these errors were encountered:

It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".

…pythonGH-106949) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".. (cherry picked from commit f8b7fe2) Co-authored-by: Serhiy Storchaka <[email protected]>

…pythonGH-106949) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH". (cherry picked from commit f8b7fe2) Co-authored-by: Serhiy Storchaka <[email protected]>

…06949) (#107061) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".. (cherry picked from commit f8b7fe2)

…06949) (#107060) * [3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH". (cherry picked from commit f8b7fe2) Co-authored-by: Serhiy Storchaka <[email protected]> * Delete 2023-05-31-18-37-57.gh-issue-105156.R4El5V.rst

…tility functions and system calls (#107062) Co-authored-by: Serhiy Storchaka <[email protected]>

…, OS utility functions and system calls (pythonGH-107062) (cherry picked from commit b447e19) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>

…s, OS utility functions and system calls (GH-107062) (#107154) (cherry picked from commit b447e19) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>

…s, OS utility functions and system calls (#107062) (#107157) (cherry picked from commit b447e19) Co-authored-by: Serhiy Storchaka <[email protected]>

…nGH-106949) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".

…, OS utility functions and system calls (python#107062) Co-authored-by: Serhiy Storchaka <[email protected]>

* main: (73 commits) Thoroughly refactor the cases generator (python#107151) Docs: Add missing markup to Argument Clinic docs (python#106876) pythongh-107162: Document errcode.h usage in its comment (python#107177) pythongh-106320: Remove private _PyDict C API (python#107145) Fix PyVectorcall_Function doc versionadded (python#107140) Docs: Remove duplicate word in Argument Clinic howto heading (python#107169) pythongh-107017: Change Chapter Strings to Texts in the Introduction chapter. (python#107104) pythongh-106320: Remove private _PyObject C API (python#107159) Docs: fix typo in os.pwrite docstring (python#107087) pythongh-105291: Add link to migration guide for distutils (python#107130) pythongh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (python#107062) pythongh-106320: Remove _PyBytes_Join() C API (python#107144) pythongh-106320: Remove private _PyObject C API (python#107147) pythongh-106320: Remove _PyTuple_MaybeUntrack() C API (python#107143) pythongh-106320: Remove _PyIsSelectable_fd() C API (python#107142) Remove superflous whitespaces in `layout.html`. (pythonGH-107067) pythongh-107122: Update what's news for dbm.*dbm.clear() method (pythongh-107135) pythongh-107122: Add clear method to dbm.ndbm module (pythongh-107126) pythongh-62519: Make pgettext search plurals when translation is not found (python#107118) pythongh-107122: Add clear method to dbm.gdbm.module (pythongh-107127) ...

Maintaining nitpick_ignore Python list in conf.py is a burden. Add a YAML configuration file which is easier to maintain.

Maintaining nitpick_ignore Python list in conf.py is a burden. Add a YAML configuration file which is easier to maintain. Ignore also standard C types in the "c:identifier" domain.

Maintaining nitpick_ignore Python list in conf.py is a burden. Add a YAML configuration file which is easier to maintain. Ignore also standard C types in the "c:identifier" domain. Update Doc/requirements-oldest-sphinx.txt.

…domain Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. Co-Authored-By: Serhiy Storchaka <[email protected]>

…#107295) Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. Co-authored-by: Serhiy Storchaka <[email protected]>

…domain (pythonGH-107295) Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. (cherry picked from commit b1de380) Co-authored-by: Victor Stinner <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>

… domain (GH-107295) (#107297) gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH-107295) Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. (cherry picked from commit b1de380) Co-authored-by: Victor Stinner <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>

…domain (python#107295) Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. Co-authored-by: Serhiy Storchaka <[email protected]> (cherry picked from commit b1de380)

… domain (#107295) (#107299) gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295) Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. Co-authored-by: Serhiy Storchaka <[email protected]> (cherry picked from commit b1de380)

Complete nitpick_ignore list in Doc/conf.py to ignore more standard C functions, variables, macros, and also Win32 API functions and macros.

Complete nitpick_ignore list in Doc/conf.py to ignore more standard C functions, variables, macros, and also Win32 API functions and macros. No longer ignore "__int" C type: it should not be used in the doc.

…domain (python#107295) Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. Co-authored-by: Serhiy Storchaka <[email protected]>

serhiy-storchaka · 2023-08-16T17:51:15Z

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

serhiy-storchaka added the docs Documentation in the Doc dir label Jul 21, 2023

bedevere-bot mentioned this issue Jul 21, 2023

gh-106948: Add standard external names to nitpick_ignore #106949

Merged

wulmer mentioned this issue Jul 22, 2023

Fix Sphinx warnings in re library docs #107044

Merged

serhiy-storchaka added a commit that referenced this issue Jul 22, 2023

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

f8b7fe2

It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".

bedevere-bot mentioned this issue Jul 22, 2023

[3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) #107060

Merged

bedevere-bot mentioned this issue Jul 22, 2023

[3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) #107061

Merged

serhiy-storchaka linked a pull request Jul 23, 2023 that will close this issue

gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls #107062

Merged

serhiy-storchaka removed a link to a pull request Jul 23, 2023

gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls #107062

Merged

erlend-aasland added a commit that referenced this issue Jul 23, 2023

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

b447e19

…tility functions and system calls (#107062) Co-authored-by: Serhiy Storchaka <[email protected]>

bedevere-bot mentioned this issue Jul 23, 2023

[3.12] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (GH-107062) #107154

Merged

bedevere-bot mentioned this issue Jul 23, 2023

[3.11] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (#107062) #107157

Merged

mementum pushed a commit to mementum/cpython that referenced this issue Jul 23, 2023

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

9115c45

…, OS utility functions and system calls (python#107062) Co-authored-by: Serhiy Storchaka <[email protected]>

vstinner added a commit to vstinner/cpython that referenced this issue Jul 25, 2023

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

28b988b

Maintaining nitpick_ignore Python list in conf.py is a burden. Add a YAML configuration file which is easier to maintain.

bedevere-bot mentioned this issue Jul 25, 2023

gh-106948: Add Doc/nitpick_ignore.yml config file #107278

Closed

bedevere-bot mentioned this issue Jul 26, 2023

gh-106948: Update documentation nitpick_ignore for c:identifer domain #107295

Merged

bedevere-bot mentioned this issue Jul 26, 2023

[3.12] gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH-107295) #107297

Merged

vstinner mentioned this issue Jul 26, 2023

Fix Sphinx warnings in the C API documentation #107298

Closed

bedevere-bot mentioned this issue Jul 26, 2023

[3.11] gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295) #107299

Merged

bedevere-bot mentioned this issue Jul 26, 2023

gh-106948: Doc config ignores more standard C functions #107301

Closed

vstinner mentioned this issue Jul 26, 2023

gh-107298: Fix doc references to undocumented modules #107300

Merged

serhiy-storchaka closed this as completed Aug 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: add standard external names to nitpick_ignore #106948

Docs: add standard external names to nitpick_ignore #106948

serhiy-storchaka commented Jul 21, 2023 •

edited by bedevere-bot

Loading

serhiy-storchaka commented Aug 16, 2023

Docs: add standard external names to nitpick_ignore #106948

Docs: add standard external names to nitpick_ignore #106948

Comments

serhiy-storchaka commented Jul 21, 2023 • edited by bedevere-bot Loading

Linked PRs

serhiy-storchaka commented Aug 16, 2023

serhiy-storchaka commented Jul 21, 2023 •

edited by bedevere-bot

Loading