Merge pull request #46 from executablebooks/fix/41/update-domain-name

👌 IMPROVE: Rename "proof" domain and role to "prf"

Author: najuzilu

docs/source/index.md

@@ -28,7 +28,7 @@ sphinxcontrib-prettyproof `0.0.2` is in a development stage and may change rapid
 
 1. directives are automatically numbered
 2. supports directive options such as `class`, `label`, and `nonumber`
-3. can easily be referenced through `proof:ref` role
+3. can easily be referenced through `prf:ref` role
 
 (getting-started)=
 ## Getting Started

docs/source/syntax.md

@@ -35,14 +35,14 @@ class ElementDirective(SphinxDirective):
 
     def run(self) -> List[Node]:
         env = self.env
-        domain_name, typ = self.name.split(":")[0], self.name.split(":")[1]
+        typ = self.name.split(":")[1]
         serial_no = env.new_serialno()
 
         if not hasattr(env, "proof_list"):
             env.proof_list = {}
 
         # If class in options add to class array
-        classes, class_name = [domain_name, typ], self.options.get("class", [])
+        classes, class_name = ["proof", typ], self.options.get("class", [])
         if class_name:
             classes.extend(class_name)
 
@@ -114,10 +114,10 @@ class ProofDirective(SphinxDirective):
     }
 
     def run(self) -> List[Node]:
-        domain_name, typ = self.name.split(":")[0], self.name.split(":")[1]
+        typ = self.name.split(":")[1]
 
         # If class in options add to class array
-        classes, class_name = [domain_name, typ], self.options.get("class", [])
+        classes, class_name = ["proof", typ], self.options.get("class", [])
         if class_name:
             classes.extend(class_name)
 

sphinxcontrib/prettyproof/directive.py

@@ -27,7 +27,7 @@
 
 class ProofIndex(Index):
 
-    name = "proof"
+    name = "prf"
     localname = "Proof Index"
     shortname = "Proof"
 
@@ -62,13 +62,13 @@ def result_nodes(
         self, document: document, env: BuildEnvironment, node: Element, is_ref: bool
     ) -> Tuple[List[Node], List[system_message]]:
 
-        node["refdomain"] = "proof"
+        node["refdomain"] = "prf"
         return [node], []
 
 
 class ProofDomain(Domain):
 
-    name = "proof"
+    name = "prf"
     label = "Proof Domain"
 
     roles = {"ref": ProofXRefRole()}

sphinxcontrib/prettyproof/domain.py

@@ -1,13 +1,13 @@
 index
 =====
 
-.. proof:algorithm:: Test algorithm directive
+.. prf:algorithm:: Test algorithm directive
 	:label: label-1
 
 	Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
 
-.. proof:algorithm::
+.. prf:algorithm::
 	:label: label-1
 
 	Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

tests/books/test-duplicatelabel/index.rst

@@ -1,4 +1,4 @@
 index
 =====
 
-This is a missing ref :proof:ref:`foo`.
+This is a missing ref :prf:ref:`foo`.

tests/books/test-missingref/index.rst

@@ -1,7 +1,7 @@
 content 1
 =========
 
-.. proof:algorithm:: Test algorithm directive
+.. prf:algorithm:: Test algorithm directive
 	:class: test-algo
 	:label: test-algo-label
 

tests/books/test-mybook/algorithm/_algo_labeled_titled_with_classname.rst

@@ -1,7 +1,7 @@
 content 2
 =========
 
-.. proof:algorithm:: Test algorithm directive
+.. prf:algorithm:: Test algorithm directive
 	:nonumber:
 
 	Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

tests/books/test-mybook/algorithm/_algo_nonumber.rst

@@ -1,4 +1,4 @@
 content 3
 =========
 
-referencing with number :proof:ref:`test-algo-label`.
+referencing with number :prf:ref:`test-algo-label`.

tests/books/test-mybook/algorithm/_algo_numbered_reference.rst

@@ -1,4 +1,4 @@
 content 4
 =========
 
-referencing with text: :proof:ref:`text <test-algo-label>`.
+referencing with text: :prf:ref:`text <test-algo-label>`.