Docs: add standard external names to nitpick_ignore #106948
Description
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
pythongh-106948: Add standard external names to nitpick_ignore
gh-106948: Add standard external names to nitpick_ignore (GH-106949)
[3.12] pythongh-106948: Add standard external names to nitpick_ignore (…
[3.11] pythongh-106948: Add standard external names to nitpick_ignore (…
[3.12] pythongh-106948: Add standard external names to nitpick_ignore (…
[3.11] gh-106948: Add standard external names to nitpick_ignore (GH-1…
[3.12] gh-106948: Add standard external names to nitpick_ignore (GH-1…
gh-106948: Docs: Disable links for C standard library functions, OS u…
pythongh-106948: Docs: Disable links for C standard library functions…
[3.12] gh-106948: Docs: Disable links for C standard library function…
[3.11] gh-106948: Docs: Disable links for C standard library function…
pythongh-106948: Add standard external names to nitpick_ignore (pytho…
2 remaining items
pythongh-106948: Add Doc/nitpick_ignore.yml config file
pythongh-106948: Add Doc/nitpick_ignore.yml config file
pythongh-106948: Add Doc/nitpick_ignore.yml config file
pythongh-106948: Update documentation nitpick_ignore for c:identifer …
gh-106948: Update documentation nitpick_ignore for c:identifer domain (…
pythongh-106948: Update documentation nitpick_ignore for c:identifer …
[3.12] gh-106948: Update documentation nitpick_ignore for c:identifer…
pythongh-106948: Update documentation nitpick_ignore for c:identifer …
[3.11] gh-106948: Update documentation nitpick_ignore for c:identifer…
pythongh-106948: Doc config ignores more standard C functions
pythongh-106948: Doc config ignores more standard C functions
pythongh-106948: Doc config ignores more standard C functions
pythongh-106948: Update documentation nitpick_ignore for c:identifer …
serhiy-storchaka commentedon Aug 16, 2023
It's all for now. Additional names can be added in separate issues or even without opening a special issue.