generate parameter tables from XML using MkDocs hook

wannier-developers · May 9, 2024 · 64f6e08 · 64f6e08
1 parent bbf3f1c
commit 64f6e08
Show file tree

Hide file tree

Showing 17 changed files with 42 additions and 354 deletions.
diff --git a/docs/docs/parameters/generate-parameter-tables.py b/docs/docs/parameters/generate-parameter-tables.py
@@ -1,42 +1,44 @@
+import pathlib
 import xml.etree.ElementTree as ET
 
 
-groups = {
-    'w90': [
-        'disentanglement',
-        'job',
-        'plot',
-        'system',
-        'transport',
-        'wannierise',
-    ],
-    'postw90': [
-        'berry',
-        'boltzwann',
-        'dos',
-        'geninterp',
-        'global',
-        'gyrotropic',
-        'kpath',
-        'kslice',
-    ],
-}
+def on_pre_build(config):
+    groups = {
+        'w90': [
+            'disentanglement',
+            'job',
+            'plot',
+            'system',
+            'transport',
+            'wannierise',
+        ],
+        'postw90': [
+            'berry',
+            'boltzwann',
+            'dos',
+            'geninterp',
+            'global',
+            'gyrotropic',
+            'kpath',
+            'kslice',
+        ],
+    }
 
-tree = ET.parse('parameters.xml')
-root = tree.getroot()
+    tree = ET.parse(pathlib.Path(config.docs_dir)/'parameters/parameters.xml')
+    root = tree.getroot()
 
-for tool in ['w90', 'postw90']:
-    for group in groups[tool]:
-        parameters = root.findall(f'./parameter[@tool="{tool}"][@group="{group}"]')
-        with open(f'{tool}-{group}-parameters.csv', 'w') as fp:
-            print('Keyword,Type,Description', file=fp)
-            for parameter in parameters:
-                name = parameter.find('name')
-                type = parameter.find('type')
-                description = parameter.find('description')
-                if 'optional_prefix' in name.attrib:
-                    print(f'[{name.attrib["optional_prefix"]}]{name.text},', end='', file=fp)
-                else:
-                    print(f'{name.text},', end='', file=fp)
-                print(f'{type.text},', end='', file=fp)
-                print(f'"{description.text}"', file=fp)
+    for tool in ['w90', 'postw90']:
+        for group in groups[tool]:
+            parameters = root.findall(f'./parameter[@tool="{tool}"][@group="{group}"]')
+            with open(pathlib.Path(config.docs_dir)/f'parameters/{tool}-{group}-parameters.csv', 'w') as fp:
+                print('Keyword,Type,Description', file=fp)
+                for parameter in parameters:
+                    name = parameter.find('name')
+                    type = parameter.find('type')
+                    description = parameter.find('description')
+                    if 'optional_prefix' in name.attrib:
+                        print(f'[{name.attrib["optional_prefix"]}]{name.text},', end='', file=fp)
+                    else:
+                        print(f'{name.text},', end='', file=fp)
+                    print(f'{type.text},', end='', file=fp)
+                    print(f'"{description.text}"', file=fp)
diff --git a/docs/docs/parameters/parameters-csv2xml.py b/docs/docs/parameters/parameters-csv2xml.py
diff --git a/docs/docs/parameters/postw90-berry-parameters.csv b/docs/docs/parameters/postw90-berry-parameters.csv
diff --git a/docs/docs/parameters/postw90-boltzwann-parameters.csv b/docs/docs/parameters/postw90-boltzwann-parameters.csv
diff --git a/docs/docs/parameters/postw90-dos-parameters.csv b/docs/docs/parameters/postw90-dos-parameters.csv
diff --git a/docs/docs/parameters/postw90-geninterp-parameters.csv b/docs/docs/parameters/postw90-geninterp-parameters.csv
diff --git a/docs/docs/parameters/postw90-global-parameters.csv b/docs/docs/parameters/postw90-global-parameters.csv
diff --git a/docs/docs/parameters/postw90-gyrotropic-parameters.csv b/docs/docs/parameters/postw90-gyrotropic-parameters.csv
diff --git a/docs/docs/parameters/postw90-kpath-parameters.csv b/docs/docs/parameters/postw90-kpath-parameters.csv
diff --git a/docs/docs/parameters/postw90-kslice-parameters.csv b/docs/docs/parameters/postw90-kslice-parameters.csv
diff --git a/docs/docs/parameters/w90-disentanglement-parameters.csv b/docs/docs/parameters/w90-disentanglement-parameters.csv
diff --git a/docs/docs/parameters/w90-job-parameters.csv b/docs/docs/parameters/w90-job-parameters.csv