added numbering support for other directives

Author: AakashGfude

sphinx_proof/__init__.py

@@ -10,10 +10,16 @@
 from sphinx.config import Config
 from sphinx.application import Sphinx
 from sphinx.environment import BuildEnvironment
-from .nodes import enumerable_node, visit_enumerable_node, depart_enumerable_node
-from .nodes import unenumerable_node, visit_unenumerable_node, depart_unenumerable_node
+from .nodes import visit_enumerable_node, depart_enumerable_node
+from .nodes import (
+    NODE_TYPES,
+    unenumerable_node,
+    visit_unenumerable_node,
+    depart_unenumerable_node,
+)
 from .nodes import proof_node, visit_proof_node, depart_proof_node
 from .domain import ProofDomain
+from .proof_type import PROOF_TYPES
 from sphinx.util import logging
 from sphinx.util.fileutil import copy_asset
 
@@ -83,14 +89,15 @@ def setup(app: Sphinx) -> Dict[str, Any]:
         html=(visit_unenumerable_node, depart_unenumerable_node),
         latex=(visit_unenumerable_node, depart_unenumerable_node),
     )
-    app.add_enumerable_node(
-        enumerable_node,
-        "proof",
-        None,
-        singlehtml=(visit_enumerable_node, depart_enumerable_node),
-        html=(visit_enumerable_node, depart_enumerable_node),
-        latex=(visit_enumerable_node, depart_enumerable_node),
-    )
+    for node in PROOF_TYPES.keys():
+        app.add_enumerable_node(
+            NODE_TYPES[node],
+            node,
+            None,
+            singlehtml=(visit_enumerable_node, depart_enumerable_node),
+            html=(visit_enumerable_node, depart_enumerable_node),
+            latex=(visit_enumerable_node, depart_enumerable_node),
+        )
 
     return {
         "version": "builtin",

sphinx_proof/directive.py

@@ -13,7 +13,7 @@
 from sphinx.util import logging
 from docutils.parsers.rst import directives
 from sphinx.util.docutils import SphinxDirective
-from .nodes import enumerable_node, unenumerable_node
+from .nodes import unenumerable_node, NODE_TYPES
 from .nodes import proof_node
 
 logger = logging.getLogger(__name__)
@@ -37,7 +37,6 @@ def run(self) -> List[Node]:
         env = self.env
         typ = self.name.split(":")[1]
         serial_no = env.new_serialno()
-
         if not hasattr(env, "proof_list"):
             env.proof_list = {}
 
@@ -76,7 +75,8 @@ def run(self) -> List[Node]:
         if "nonumber" in self.options:
             node = unenumerable_node()
         else:
-            node = enumerable_node()
+            node_type = NODE_TYPES[typ]
+            node = node_type()
 
         node.document = self.state.document
         node += nodes.title(title_text, "", *textnodes)

sphinx_proof/domain.py

@@ -119,6 +119,9 @@ def resolve_xref(
 
         todocname = match["docname"]
         title = contnode[0]
+        import pdb
+
+        pdb.set_trace()
         if target in contnode[0]:
             number = ""
             if not env.proof_list[target]["nonumber"]:

sphinx_proof/nodes.py

@@ -20,6 +20,22 @@ class proof_node(nodes.Admonition, nodes.Element):
     pass
 
 
+class axiom_node(nodes.Admonition, nodes.Element):
+    pass
+
+
+class theorem_node(nodes.Admonition, nodes.Element):
+    pass
+
+
+class lemma_node(nodes.Admonition, nodes.Element):
+    pass
+
+
+class algorithm_node(nodes.Admonition, nodes.Element):
+    pass
+
+
 class enumerable_node(nodes.Admonition, nodes.Element):
     pass
 
@@ -28,6 +44,14 @@ class unenumerable_node(nodes.Admonition, nodes.Element):
     pass
 
 
+NODE_TYPES = {
+    "axiom": axiom_node,
+    "theorem": theorem_node,
+    "lemma": lemma_node,
+    "algorithm": algorithm_node,
+}
+
+
 def visit_enumerable_node(self, node: Node) -> None:
     if isinstance(self, LaTeXTranslator):
         docname = find_parent(self.builder.env, node, "section")
@@ -40,13 +64,16 @@ def visit_enumerable_node(self, node: Node) -> None:
 def depart_enumerable_node(self, node: Node) -> None:
     typ = node.attributes.get("type", "")
     if isinstance(self, LaTeXTranslator):
-        number = get_node_number(self, node)
+        number = get_node_number(self, node, typ)
         idx = list_rindex(self.body, latex_admonition_start) + 2
         self.body.insert(idx, f"{typ.title()} {number}")
         self.body.append(latex_admonition_end)
     else:
         # Find index in list of 'Proof #'
-        number = get_node_number(self, node)
+        number = get_node_number(self, node, typ)
+        import pdb
+
+        pdb.set_trace()
         idx = self.body.index(f"Proof {number} ")
         self.body[idx] = f"{typ.title()} {number} "
         self.body.append("</div>")
@@ -86,9 +113,8 @@ def depart_proof_node(self, node: Node) -> None:
     pass
 
 
-def get_node_number(self, node: Node) -> str:
+def get_node_number(self, node: Node, typ) -> str:
     """Get the number for the directive node for HTML."""
-    key = "proof"
     ids = node.attributes.get("ids", [])[0]
     if isinstance(self, LaTeXTranslator):
         docname = find_parent(self.builder.env, node, "section")
@@ -97,7 +123,7 @@ def get_node_number(self, node: Node) -> str:
         )  # Latex does not have builder.fignumbers
     else:
         fignumbers = self.builder.fignumbers
-    number = fignumbers.get(key, {}).get(ids, ())
+    number = fignumbers.get(typ, {}).get(ids, ())
     return ".".join(map(str, number))
 
 

sphinx_proof/proof_type.py

@@ -93,14 +93,16 @@ class PropositionDirective(ElementDirective):
     "axiom": AxiomDirective,
     "theorem": TheoremDirective,
     "lemma": LemmaDirective,
-    "definition": DefinitionDirective,
-    "remark": RemarkDirective,
-    "conjecture": ConjectureDirective,
-    "corollary": CorollaryDirective,
     "algorithm": AlgorithmDirective,
-    "criterion": CriterionDirective,
-    "example": ExampleDirective,
-    "property": PropertyDirective,
-    "observation": ObservationDirective,
-    "proposition": PropositionDirective,
 }
+
+# "definition": DefinitionDirective,
+# "remark": RemarkDirective,
+# "conjecture": ConjectureDirective,
+# "corollary": CorollaryDirective,
+# "algorithm": AlgorithmDirective,
+# "criterion": CriterionDirective,
+# "example": ExampleDirective,
+# "property": PropertyDirective,
+# "observation": ObservationDirective,
+# "proposition": PropositionDirective,