[docs] Improve linkage of convert script documentation

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

Hide file tree

Showing 9 changed files with 55 additions and 5 deletions.
diff --git a/doc/sphinx/cython/ck_conversion.rst 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
+<https://cantera.org/tutorials/ck2yaml-tutorial.html>`_ pages.
+
+Module-level documentation
+==========================
+
+.. automodule:: cantera.ck2yaml
diff --git 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 <sec-cti2yaml>`
+section. For a tutorial, refer to the `Converting CTI and XML input files to YAML
+<https://cantera.org/tutorials/legacy2yaml.html>`_ pages.
+
+Module-level documentation
+==========================
+
 .. automodule:: cantera.cti2yaml
diff --git 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 <sec-ctml2yaml>`
+section. For a tutorial, refer to the `Converting CTI and XML input files to YAML
+<https://cantera.org/tutorials/legacy2yaml.html>`_ 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
@@ -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
@@ -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
@@ -1,3 +1,7 @@
 **************************
 Chemkin to YAML conversion
 **************************
+
+.. note::
+    For documentation and tutorial, refer to the `Converting Chemkin-format files
+    <https://cantera.org/tutorials/ck2yaml-tutorial.html>`_ pages.
diff --git 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
+    <https://cantera.org/tutorials/legacy2yaml.html>`_ pages.
+
 .. argparse::
    :module: cantera.cti2yaml
    :func: create_argparser

diff --git 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
+    <https://cantera.org/tutorials/legacy2yaml.html>`_ pages.
+
 .. argparse::
    :module: cantera.ctml2yaml
    :func: create_argparser

diff --git a/doc/sphinx/yaml/yaml2ck.rst b/doc/sphinx/yaml/yaml2ck.rst
@@ -1,3 +1,5 @@
+.. _sec-yaml2ck:
+
 **************************
 YAML to Chemkin conversion
 **************************