mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-22 09:45:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

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

Browse source 
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 <storchaka@gmail.com>
This commit is contained in:
Victor Stinner 2023-07-26 18:04:46 +02:00 • committed by GitHub
parent da8f87b7ea
commit b1de3807b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/conf.py
View file

@ -153,6 +153,15 @@ nitpick_ignore = [
('py:meth', '_SubParsersAction.add_parser'), ('py:meth', '_SubParsersAction.add_parser'),
] ]
# gh-106948: 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. Use list() to not iterate on items which are being
# added
for role, name in list(nitpick_ignore):
if role == 'c:type':
nitpick_ignore.append(('c:identifier', name))
del role, name
# Disable Docutils smartquotes for several translations # Disable Docutils smartquotes for several translations
smartquotes_excludes = { smartquotes_excludes = {
'languages': ['ja', 'fr', 'zh_TW', 'zh_CN'], 'builders': ['man', 'text'], 'languages': ['ja', 'fr', 'zh_TW', 'zh_CN'], 'builders': ['man', 'text'],

3
Doc/tools/.nitignore
View file

@ -8,7 +8,6 @@ Doc/c-api/arg.rst
Doc/c-api/bool.rst Doc/c-api/bool.rst
Doc/c-api/buffer.rst Doc/c-api/buffer.rst
Doc/c-api/bytes.rst Doc/c-api/bytes.rst
Doc/c-api/call.rst
Doc/c-api/capsule.rst Doc/c-api/capsule.rst
Doc/c-api/cell.rst Doc/c-api/cell.rst
Doc/c-api/code.rst Doc/c-api/code.rst
@ -26,8 +25,6 @@ Doc/c-api/init.rst
Doc/c-api/init_config.rst Doc/c-api/init_config.rst
Doc/c-api/intro.rst Doc/c-api/intro.rst
Doc/c-api/iterator.rst Doc/c-api/iterator.rst
Doc/c-api/long.rst
Doc/c-api/marshal.rst
Doc/c-api/memory.rst Doc/c-api/memory.rst
Doc/c-api/memoryview.rst Doc/c-api/memoryview.rst
Doc/c-api/module.rst Doc/c-api/module.rst