cell_index wrapped as Sphinx extension

docs/_ext/cell_list.py

@@ -24,6 +24,10 @@ import pathlib
 import pprint
 import sys
 import textwrap
+from docutils import nodes
+from docutils.parsers.rst import Directive
+from docutils.statemachine import ViewList
+from sphinx.util.nodes import nested_parse_with_titles
 
 from typing import Tuple, List, Dict
 
@@ -91,7 +95,7 @@ def collect(library_dir) -> Tuple[str, List[str]]:
 
 
 def generate_rst(library_dir, library_name, cells):
-    """Generate the RST file containing basic information about cells
+    """Generate the RST paragraph containing basic information about cells
 
     Parameters
     ----------
@@ -106,15 +110,14 @@ def generate_rst(library_dir, library_name, cells):
 
     Returns
     -------
-    path: str
+    paragraph: str
-        Path to generated file
+        Generated paragraph
     """
 
     if not isinstance(library_dir, pathlib.Path):
         library_dir = pathlib.Path(library_dir)
 
-    file_name = "cell-list.rst"
+    paragraph = ""
-    cell_list_file = pathlib.Path(library_dir, file_name)
     cell_list = ""
 
     for cell in cells:
@@ -129,19 +132,42 @@ def generate_rst(library_dir, library_name, cells):
             )
 
     header = rst_header.format(libname = library_name)
-    try:
+    paragraph = rst_template.format(
-        with(open(str(cell_list_file), "w")) as c:
-            c.write(rst_template.format(
                 header_line = header,
                 header_underline = rst_header_line_char * len(header),
                 cell_list = cell_list
-            ))
+            )
-    except FileNotFoundError:
+    return paragraph
-        print(f"ERROR: Failed to create {str(cell_list_file)}", file=sys.stderr)
-        raise
 
-    return cell_list_file
+# --- Sphinx extension wrapper ---
 
+class CellList(Directive):
+
+    def run(self):
+        env = self.state.document.settings.env
+        dirname = env.docname.rpartition('/')[0]
+        libname, cells = collect(dirname)
+        paragraph = generate_rst(dirname, libname, cells)
+        # parse rst string to docutils nodes
+        rst = ViewList()
+        for i,line in enumerate(paragraph.split('\n')):
+            rst.append(line, libname+"-cell-list.rst", i+1) 
+        node = nodes.section()
+        node.document = self.state.document
+        nested_parse_with_titles(self.state, rst, node)
+        return node.children
+
+
+def setup(app):
+    app.add_directive("cell_list", CellList)
+
+    return {
+        'version': '0.1',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }
+
+# --- stand alone, command line operation ---
 
 def main():
     parser = argparse.ArgumentParser()
@@ -157,8 +183,16 @@ def main():
     print(f"Analysing {lib}")
     libname, cells = collect(lib)
     print(f"Library name: {libname}, found {len(cells)} cells")
-    file = generate_rst(lib, libname, cells)
+    paragraph = generate_rst(lib, libname, cells)
-    print(f'Generated {file}')
+    library_dir = pathlib.Path(lib)
+    cell_list_file = pathlib.Path(library_dir, "cell-list.rst")
+    try:
+        with(open(str(cell_list_file), "w")) as c:
+            c.write(paragraph)
+        print(f'Generated {cell_list_file}')
+    except FileNotFoundError:
+        print(f"ERROR: Failed to create {str(cell_list_file)}", file=sys.stderr)
+        raise
 
 
 if __name__ == "__main__":

docs/conf.py

@@ -31,8 +31,9 @@
 import docutils
 import os
 import re
-# import sys
+import sys
 # sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('./_ext'))
 
 
 # -- Project information -----------------------------------------------------
@@ -65,6 +66,7 @@ extensions = [
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinxcontrib_hdl_diagrams',
+    'cell_list',
 ]
 
 # Add any paths that contain templates here, relative to this directory.