diff --git a/doc/sphinx/cython/ck_conversion.rst b/doc/sphinx/cython/ck_conversion.rst new file mode 100644 index 0000000000..27aca26319 --- /dev/null +++ b/doc/sphinx/cython/ck_conversion.rst @@ -0,0 +1,11 @@ +************************** +Chemkin to YAML conversion +************************** + +For documentation and tutorial, refer to the `Converting Chemkin-format files +`_ pages. + +Module-level documentation +========================== + +.. automodule:: cantera.ck2yaml diff --git a/doc/sphinx/cython/cti_conversion.rst b/doc/sphinx/cython/cti_conversion.rst index cfb900cd8a..642062cc5c 100644 --- a/doc/sphinx/cython/cti_conversion.rst +++ b/doc/sphinx/cython/cti_conversion.rst @@ -2,4 +2,11 @@ CTI to YAML conversion *********************** +For documentation of the command line interface, see the :ref:`cti2yaml ` +section. For a tutorial, refer to the `Converting CTI and XML input files to YAML +`_ pages. + +Module-level documentation +========================== + .. automodule:: cantera.cti2yaml diff --git a/doc/sphinx/cython/ctml_conversion.rst b/doc/sphinx/cython/ctml_conversion.rst index b0b982a7af..5d43ac9cee 100644 --- a/doc/sphinx/cython/ctml_conversion.rst +++ b/doc/sphinx/cython/ctml_conversion.rst @@ -2,6 +2,14 @@ CTML to YAML conversion *********************** +For documentation of the command line interface, see the :ref:`cml2yaml ` +section. For a tutorial, refer to the `Converting CTI and XML input files to YAML +`_ pages. + + +Module-level documentation +========================== + .. py:module:: cantera.ctml2yaml .. py:currentmodule:: cantera.ctml2yaml @@ -16,7 +24,7 @@ processed, while `convert` takes an input filename or a string containing the CT to be converted, and optionally the name of the output file. Module-level functions -====================== +---------------------- .. autofunction:: float2string .. autofunction:: represent_float @@ -30,7 +38,7 @@ Module-level functions .. autofunction:: main Conversion classes -================== +------------------ .. autoclass:: Phase :no-undoc-members: @@ -44,7 +52,7 @@ Conversion classes :no-undoc-members: Exceptions -========== +---------- .. autoexception:: MissingXMLNode .. autoexception:: MissingXMLAttribute diff --git a/doc/sphinx/cython/scripts.rst b/doc/sphinx/cython/scripts.rst index f700214246..b014132afc 100644 --- a/doc/sphinx/cython/scripts.rst +++ b/doc/sphinx/cython/scripts.rst @@ -1,13 +1,14 @@ .. _sec-converter-documentation: -Python Converter Modules -======================== +Mechanism Conversion +==================== Contents: .. toctree:: :maxdepth: 1 + ck_conversion cti_conversion ctml_conversion yaml_conversion diff --git a/doc/sphinx/cython/yaml_conversion.rst b/doc/sphinx/cython/yaml_conversion.rst index 8dda685ef9..ffa976d866 100644 --- a/doc/sphinx/cython/yaml_conversion.rst +++ b/doc/sphinx/cython/yaml_conversion.rst @@ -2,4 +2,9 @@ YAML to Chemkin conversion ************************** +For documentation of the command line interface, see :ref:`sec-yaml2ck`. + +Module-level documentation +========================== + .. automodule:: cantera.yaml2ck diff --git a/doc/sphinx/yaml/ck2yaml.rst b/doc/sphinx/yaml/ck2yaml.rst index 025c5820d2..1f0a76b29e 100644 --- a/doc/sphinx/yaml/ck2yaml.rst +++ b/doc/sphinx/yaml/ck2yaml.rst @@ -1,3 +1,7 @@ ************************** Chemkin to YAML conversion ************************** + +.. note:: + For documentation and tutorial, refer to the `Converting Chemkin-format files + `_ pages. diff --git a/doc/sphinx/yaml/cti2yaml.rst b/doc/sphinx/yaml/cti2yaml.rst index 25d9ed4c1a..c8e842dc78 100644 --- a/doc/sphinx/yaml/cti2yaml.rst +++ b/doc/sphinx/yaml/cti2yaml.rst @@ -1,7 +1,13 @@ +.. _sec-cti2yaml: + *********************** CTI to YAML conversion *********************** +.. note:: + For a tutorial, refer to the `Converting CTI and XML input files to YAML + `_ pages. + .. argparse:: :module: cantera.cti2yaml :func: create_argparser diff --git a/doc/sphinx/yaml/ctml2yaml.rst b/doc/sphinx/yaml/ctml2yaml.rst index ba89312982..4a638b262d 100644 --- a/doc/sphinx/yaml/ctml2yaml.rst +++ b/doc/sphinx/yaml/ctml2yaml.rst @@ -1,7 +1,13 @@ +.. _sec-ctml2yaml: + *********************** CTML to YAML conversion *********************** +.. note:: + For a tutorial, refer to the `Converting CTI and XML input files to YAML + `_ pages. + .. argparse:: :module: cantera.ctml2yaml :func: create_argparser diff --git a/doc/sphinx/yaml/yaml2ck.rst b/doc/sphinx/yaml/yaml2ck.rst index 58e1e07ca7..51ed171344 100644 --- a/doc/sphinx/yaml/yaml2ck.rst +++ b/doc/sphinx/yaml/yaml2ck.rst @@ -1,3 +1,5 @@ +.. _sec-yaml2ck: + ************************** YAML to Chemkin conversion **************************