[docs] Use sphinx-argparse

Cantera · Aug 13, 2023 · b573626 · b573626
1 parent 08d906a
commit b573626
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 0 deletions.
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
@@ -39,6 +39,7 @@
               'sphinx.ext.autodoc',
               'sphinx.ext.todo',
               'sphinx.ext.autosummary',
+              'sphinxarg.ext',
               'sphinxcontrib.doxylink',
               'sphinx.ext.intersphinx',
               ]

diff --git a/doc/sphinx/yaml/ck2yaml.rst b/doc/sphinx/yaml/ck2yaml.rst
@@ -0,0 +1,3 @@
+**************************
+Chemkin to YAML conversion
+**************************
diff --git a/doc/sphinx/yaml/cti2yaml.rst b/doc/sphinx/yaml/cti2yaml.rst
@@ -0,0 +1,8 @@
+***********************
+CTI to YAML conversion
+***********************
+
+.. argparse::
+   :module: cantera.cti2yaml
+   :func: create_argparser
+   :prog: cti2yaml
diff --git a/doc/sphinx/yaml/ctml2yaml.rst b/doc/sphinx/yaml/ctml2yaml.rst
@@ -0,0 +1,8 @@
+***********************
+CTML to YAML conversion
+***********************
+
+.. argparse::
+   :module: cantera.ctml2yaml
+   :func: create_argparser
+   :prog: ctml2yaml
diff --git a/doc/sphinx/yaml/index.rst b/doc/sphinx/yaml/index.rst
@@ -11,3 +11,7 @@ YAML Input File Reference
    elements
    species
    reactions
+   ck2yaml
+   cti2yaml
+   ctml2yaml
+   yaml2ck
diff --git a/doc/sphinx/yaml/yaml2ck.rst b/doc/sphinx/yaml/yaml2ck.rst
@@ -0,0 +1,8 @@
+**************************
+YAML to Chemkin conversion
+**************************
+
+.. argparse::
+   :module: cantera.yaml2ck
+   :func: create_argparser
+   :prog: yaml2ck