Template component docs (after hpcflow/hpcflow-new#705)

dkfellows · Dec 6, 2024 · 40d4a3d · 40d4a3d
1 parent a8bd0b6
commit 40d4a3d
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 59 deletions.
diff --git a/docs/source/reference/template_components/command_files.rst b/docs/source/reference/template_components/command_files.rst
@@ -7,5 +7,5 @@ Command files
 
    {{i.label}}
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-   {{i}}
+   {{i.documentation}}
    {% endfor %}
diff --git a/docs/source/reference/template_components/environments.rst b/docs/source/reference/template_components/environments.rst
@@ -7,5 +7,5 @@ Environments
 
    {{i.name}}
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-   {{i}}
+   {{i.documentation}}
    {% endfor %}
diff --git a/matflow/data/template_components/command_files.yaml b/matflow/data/template_components/command_files.yaml
@@ -1,65 +1,65 @@
 - label: damask_geom_file
   name:
     name: geom.vti
-# DAMASK geometry file.
+  doc: DAMASK geometry file.
 
 - label: damask_load_file
   name:
     name: load.yaml
-# DAMASK load file, as YAML.
+  doc: DAMASK load file, as YAML.
 
 - label: damask_material_file
   name:
     name: material.yaml
-# DAMASK material descriptor file.
+  doc: DAMASK material descriptor file.
 
 - label: damask_numerics_file
   name:
     name: numerics.yaml
-# DAMASK numeric control file.
+  doc: DAMASK numeric control file.
 
 - label: damask_stdout_file
   name:
     name: stdout.log
-# DAMASK standard output.
+  doc: DAMASK standard output.
 
 - label: damask_stderr_file
   name:
     name: stderr.log
-# DAMASK standard error.
+  doc: DAMASK standard error.
 
 - label: damask_hdf5_file
   name:
     name: geom_load.hdf5
-# DAMASK geometry description, as HDF5.
+  doc: DAMASK geometry description, as HDF5.
 
 - label: damask_viz_files
   name:
     name: ((?:geom_load_inc\d+|static_outputs).vt(i|r))
     is_regex: true
-# DAMASK output visualisation data.
+  doc: DAMASK output visualisation data pattern.
 
 - label: mtex_pole_figures
   name:
     name: pole_figure.png
-# MTEX figures of poles.
+  doc: MTEX figures of poles.
 
 - label: mtex_IPF_figure
   name:
     name: IPF_key.png
-# MTEX figure of inverse pole.
+  doc: MTEX figure of inverse pole.
 
 - label: dream_3D_pipeline
   name:
     name: pipeline.json
-# DREAM.3D pipeline description.
+  doc: DREAM.3D pipeline description.
 
 - label: dream_3D_hdf5_file
   name:
     name: pipeline.dream3d
-# DREAM.3D pipeline data.
+  doc: DREAM.3D pipeline data.
 
 - label: dream_3D_XDMF_file
   name:
     name: pipeline.xdmf
-# DREAM.3D model data and metadata.
+  doc: DREAM.3D model data and metadata.
diff --git a/matflow/data/template_components/environments.yaml b/matflow/data/template_components/environments.yaml
@@ -1,5 +1,5 @@
 - name: null_env
-# No special settings. Used for tests.
+  doc: Default system environment with no special settings. Used for tests.
 
 - name: python_env
   executables:
@@ -8,22 +8,22 @@
         - command: python <<script_name>> <<args>>
           num_cores: 1
           parallel_mode: null
-# For running Python; a Python virtual environment. Needs numpy and h5py.
+  doc: For running Python; a Python virtual environment. Needs numpy and h5py.
 
 - name: damask_env
-# For running DAMASK.
+  doc: For running DAMASK.
 
 - name: damask_parse_env
-# For running damask_parse; a Python virtual environment.
+  doc: For running damask_parse; a Python virtual environment.
 
 - name: formable_env
-# For running formable; a Python virtual environment.
+  doc: For running formable; a Python virtual environment.
 
 - name: matlab_env
-# For running MATLAB and MTEX.
+  doc: For running MATLAB and MTEX.
 
 - name: dream_3D_env
-# For running DREAM.3D
+  doc: For running DREAM.3D
 
 - name: defdap_env
-# For running DefDAP; a Python virtual environment.
+  doc: For running DefDAP; a Python virtual environment.