WIP: Attempt to add roles for referencing entities in the dev docs

Cantera · Oct 14, 2019 · f2c7560 · f2c7560
1 parent 003a86f
commit f2c7560
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/pages/science/phases.rst b/pages/science/phases.rst
@@ -47,6 +47,11 @@ homogeneous reactions, since the composition is fixed.)
 A stoichiometric solid can be defined in the CTI format using the
 :cti:class:`stoichiometric_solid` entry.
 
+
+A stoichiometric solid can be defined in the CTI format using the
+:ctidev:class:`stoichiometric_solid` entry.
+
+
 Stoichiometric Liquid
 ---------------------
 

diff --git a/plugins/parse_docs.py b/plugins/parse_docs.py
@@ -28,6 +28,9 @@ def set_site(self, site):
         self.site.cython_targets = {}
         self.site.cti_targets = {}
         self.site.matlab_targets = {}
+        self.site.cythondev_targets = {}
+        self.site.ctidev_targets = {}
+        self.site.matlabdev_targets = {}
 
         self.kw = {
             "output_folder": site.config["OUTPUT_FOLDER"],
@@ -45,7 +48,10 @@ def gen_tasks(self):
         def process_targets(dirname, base_dir, docs_folder):
             files = (base_dir / dirname).glob("*.html")
 
-            target_name = "{}_targets".format(dirname)
+            if 'dev' in str(base_dir):
+                target_name = "{}dev_targets".format(dirname)
+            else:
+                target_name = "{}_targets".format(dirname)
             targets_dict = getattr(self.site, target_name)
 
             duplicate_targets = []
@@ -98,9 +104,11 @@ def process_targets(dirname, base_dir, docs_folder):
         docs_folder = self.kw["docs_folders"][
             "api-docs/docs-{}".format(cantera_version)
         ]
-
         base_dir = output_folder / docs_folder / "sphinx" / "html"
 
+        dev_docs_folder = self.kw["docs_folders"]["api-docs/dev"]
+        dev_base_dir = output_folder / dev_docs_folder / "sphinx" / "html"
+
         dirs = ("cython", "matlab", "cti")
         for dirname in dirs:
             yield {
@@ -111,3 +119,11 @@ def process_targets(dirname, base_dir, docs_folder):
                     (process_targets, [dirname, base_dir, output_folder / docs_folder])
                 ],
             }
+            yield {
+                "basename": self.name,
+                "name": dirname + "dev",
+                "task_dep": ["copy_tree"],
+                "actions": [
+                    (process_targets, [dirname, dev_base_dir, output_folder / dev_docs_folder])
+                ],
+            }
diff --git a/plugins/rest_class.py b/plugins/rest_class.py
@@ -33,6 +33,7 @@ def set_site(self, site):
         roles.register_canonical_role("cti:func", class_role)
         roles.register_canonical_role("py:func", class_role)
         roles.register_canonical_role("mat:func", class_role)
+        roles.register_canonical_role("ctidev:class", class_role)
         class_role.site = site
         return super(Plugin, self).set_site(site)
 
@@ -42,7 +43,8 @@ def _class_link(name, rawtext, text):
     if class_role.site.processing_targets:
         return True, True, None, None, None, None
 
-    context_map = {"py": "cython", "mat": "matlab", "cti": "cti"}
+    context_map = {"py": "cython", "mat": "matlab", "cti": "cti",
+                   "ctidev": "ctidev"}
     context = name.split(":", 1)[0]
     if context == name:
         context = class_role.site.config["DEFAULT_CONTEXT"]