Skip to content

gh-141004: document pyexpat C API #141259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
picnixz wants to merge 10 commits into
base: main
Choose a base branch
from
+220 −4
Open

gh-141004: document pyexpat C API #141259

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5b857a4
document Expat C API
picnixz Nov 8, 2025
e20466a
suppress some references
picnixz Nov 8, 2025
1c51a14
simplify instructions
picnixz Nov 8, 2025
cf35d71
fixup
picnixz Nov 8, 2025
e7e0a7d
NULL
picnixz Nov 8, 2025
660a1a1
address review
picnixz Nov 9, 2025
cba5d4c
nevermind, `c_id_attributes` isn't for that
picnixz Nov 9, 2025
94f656b
Merge branch 'main' into docs/capi/expat-141004
picnixz Nov 9, 2025
50575b5
fixup
picnixz Nov 9, 2025
e6c452c
fix markup
picnixz Nov 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
nevermind, c_id_attributes isn't for that
  • Loading branch information
@picnixz
picnixz committed Nov 9, 2025
commit cba5d4c220393152d3a9da924700f664c4f75306
48 changes: 24 additions & 24 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,30 @@
('envvar', 'USERPROFILE'),
]

# Vendored identifiers without intersphinx support.
nitpick_ignore += [
# used in c-api/expat.rst
('c:identifier', 'XML_Bool'),
('c:identifier', 'XML_Char'),
('c:identifier', 'XML_CharacterDataHandler'),
('c:identifier', 'XML_CommentHandler'),
('c:identifier', 'XML_DefaultHandler'),
('c:identifier', 'XML_Encoding'),
('c:identifier', 'XML_EndElementHandler'),
('c:identifier', 'XML_EndNamespaceDeclHandler'),
('c:identifier', 'XML_Error'),
('c:identifier', 'XML_LChar'),
('c:identifier', 'XML_Memory_Handling_Suite'),
('c:identifier', 'XML_Parser'),
('c:identifier', 'XML_ProcessingInstructionHandler'),
('c:identifier', 'XML_Size'),
('c:identifier', 'XML_StartDoctypeDeclHandler'),
('c:identifier', 'XML_StartElementHandler'),
('c:identifier', 'XML_StartNamespaceDeclHandler'),
('c:identifier', 'XML_Status'),
('c:identifier', 'XML_UnknownEncodingHandler'),
]
Comment thread
picnixz marked this conversation as resolved.

# Temporary undocumented names.
# In future this list must be empty.
nitpick_ignore += [
Expand All @@ -247,30 +271,6 @@
nitpick_ignore.append(('c:identifier', name))
del role, name

# Vendored identifiers. The list does not need to be empty.
c_id_attributes = [
# used in c-api/expat.rst
"XML_Bool",
"XML_Char",
"XML_CharacterDataHandler",
"XML_CommentHandler",
"XML_DefaultHandler",
"XML_Encoding",
"XML_EndElementHandler",
"XML_EndNamespaceDeclHandler",
"XML_Error",
"XML_LChar",
"XML_Memory_Handling_Suite",
"XML_Parser",
"XML_ProcessingInstructionHandler",
"XML_Size",
"XML_StartDoctypeDeclHandler",
"XML_StartElementHandler",
"XML_StartNamespaceDeclHandler",
"XML_Status",
"XML_UnknownEncodingHandler",
]

# Disable Docutils smartquotes for several translations
smartquotes_excludes = {
'languages': ['ja', 'fr', 'zh_TW', 'zh_CN'],
Expand Down
Loading