summaryrefslogtreecommitdiffstats
path: root/Doc/tools
diff options
context:
space:
mode:
authorTian Gao <gaogaotiantian@hotmail.com>2023-10-18 23:15:42 (GMT)
committerGitHub <noreply@github.com>2023-10-18 23:15:42 (GMT)
commit19916941172844f9c52d7a6dce95efaa23035772 (patch)
tree4657a69325ed200821820361ba5eafff03ff945a /Doc/tools
parent94495d038732d8b31c1f39eca8fd69ee6330933d (diff)
downloadcpython-19916941172844f9c52d7a6dce95efaa23035772.zip
cpython-19916941172844f9c52d7a6dce95efaa23035772.tar.gz
cpython-19916941172844f9c52d7a6dce95efaa23035772.tar.bz2
GH-103082: Clean up the sys.monitoring docs (GH-110532)
Diffstat (limited to 'Doc/tools')
-rw-r--r--Doc/tools/extensions/pyspecific.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 4ba5f5a..11d954a 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -607,6 +607,13 @@ def parse_pdb_command(env, sig, signode):
return fullname
+def parse_monitoring_event(env, sig, signode):
+ """Transform a monitoring event signature into RST nodes."""
+ signode += addnodes.desc_addname('sys.monitoring.events.', 'sys.monitoring.events.')
+ signode += addnodes.desc_name(sig, sig)
+ return sig
+
+
def process_audit_events(app, doctree, fromdocname):
for node in doctree.traverse(audit_event_list):
break
@@ -707,6 +714,7 @@ def setup(app):
app.add_builder(PydocTopicsBuilder)
app.add_object_type('opcode', 'opcode', '%s (opcode)', parse_opcode_signature)
app.add_object_type('pdbcommand', 'pdbcmd', '%s (pdb command)', parse_pdb_command)
+ app.add_object_type('monitoring-event', 'monitoring-event', '%s (monitoring event)', parse_monitoring_event)
app.add_directive_to_domain('py', 'decorator', PyDecoratorFunction)
app.add_directive_to_domain('py', 'decoratormethod', PyDecoratorMethod)
app.add_directive_to_domain('py', 'coroutinefunction', PyCoroutineFunction)