Skip to content

Commit

Permalink
[3.11] gh-106948: Update documentation nitpick_ignore for c:identifer…
Browse files Browse the repository at this point in the history
… 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 <storchaka@gmail.com>
(cherry picked from commit b1de380)
  • Loading branch information
vstinner committed Jul 26, 2023
1 parent 36208b5 commit bd0def0
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions Doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,15 @@
('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
smartquotes_excludes = {
'languages': ['ja', 'fr', 'zh_TW', 'zh_CN'], 'builders': ['man', 'text'],
Expand Down

0 comments on commit bd0def0

Please sign in to comment.