]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Move opcode handling to Python's extension.
authorGeorg Brandl <georg@python.org>
Wed, 23 Jul 2008 15:17:09 +0000 (15:17 +0000)
committerGeorg Brandl <georg@python.org>
Wed, 23 Jul 2008 15:17:09 +0000 (15:17 +0000)
Doc/tools/sphinxext/pyspecific.py

index 568a6a107bd3353281c74d902cfd7622588d168e..9a8b897689b3b3de18dc8cd30111d0db4c8e4156 100644 (file)
@@ -85,6 +85,28 @@ class PydocTopicsBuilder(Builder):
             f.close()
 
 
+# Support for documenting Opcodes
+
+import re
+from sphinx import addnodes
+
+opcode_sig_re = re.compile(r'(\w+(?:\+\d)?)\s*\((.*)\)')
+
+def parse_opcode_signature(env, sig, signode):
+    """Transform an opcode signature into RST nodes."""
+    m = opcode_sig_re.match(sig)
+    if m is None:
+        raise ValueError
+    opname, arglist = m.groups()
+    signode += addnodes.desc_name(opname, opname)
+    paramlist = addnodes.desc_parameterlist()
+    signode += paramlist
+    paramlist += addnodes.desc_parameter(arglist, arglist)
+    return opname.strip()
+
+
 def setup(app):
     app.add_role('issue', issue_role)
     app.add_builder(PydocTopicsBuilder)
+    app.add_description_unit('opcode', 'opcode', '%s (opcode)',
+                             parse_opcode_signature)