[docs] Improve linkage of convert script documentation

This commit is contained in:
Ingmar Schoegl 2023-08-11 06:44:49 -05:00 committed by Ray Speth
parent b573626205
commit c6e5c1d5a9
9 changed files with 55 additions and 5 deletions

View File

@ -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

View File

@ -2,4 +2,11 @@
CTI to YAML conversion 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 .. automodule:: cantera.cti2yaml

View File

@ -2,6 +2,14 @@
CTML to YAML conversion 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:module:: cantera.ctml2yaml
.. py:currentmodule:: 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. to be converted, and optionally the name of the output file.
Module-level functions Module-level functions
====================== ----------------------
.. autofunction:: float2string .. autofunction:: float2string
.. autofunction:: represent_float .. autofunction:: represent_float
@ -30,7 +38,7 @@ Module-level functions
.. autofunction:: main .. autofunction:: main
Conversion classes Conversion classes
================== ------------------
.. autoclass:: Phase .. autoclass:: Phase
:no-undoc-members: :no-undoc-members:
@ -44,7 +52,7 @@ Conversion classes
:no-undoc-members: :no-undoc-members:
Exceptions Exceptions
========== ----------
.. autoexception:: MissingXMLNode .. autoexception:: MissingXMLNode
.. autoexception:: MissingXMLAttribute .. autoexception:: MissingXMLAttribute

View File

@ -1,13 +1,14 @@
.. _sec-converter-documentation: .. _sec-converter-documentation:
Python Converter Modules Mechanism Conversion
======================== ====================
Contents: Contents:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ck_conversion
cti_conversion cti_conversion
ctml_conversion ctml_conversion
yaml_conversion yaml_conversion

View File

@ -2,4 +2,9 @@
YAML to Chemkin conversion YAML to Chemkin conversion
************************** **************************
For documentation of the command line interface, see :ref:`sec-yaml2ck`.
Module-level documentation
==========================
.. automodule:: cantera.yaml2ck .. automodule:: cantera.yaml2ck

View File

@ -1,3 +1,7 @@
************************** **************************
Chemkin to YAML conversion Chemkin to YAML conversion
************************** **************************
.. note::
For documentation and tutorial, refer to the `Converting Chemkin-format files
<https://cantera.org/tutorials/ck2yaml-tutorial.html>`_ pages.

View File

@ -1,7 +1,13 @@
.. _sec-cti2yaml:
*********************** ***********************
CTI to YAML conversion 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:: .. argparse::
:module: cantera.cti2yaml :module: cantera.cti2yaml
:func: create_argparser :func: create_argparser

View File

@ -1,7 +1,13 @@
.. _sec-ctml2yaml:
*********************** ***********************
CTML to YAML conversion 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:: .. argparse::
:module: cantera.ctml2yaml :module: cantera.ctml2yaml
:func: create_argparser :func: create_argparser

View File

@ -1,3 +1,5 @@
.. _sec-yaml2ck:
************************** **************************
YAML to Chemkin conversion YAML to Chemkin conversion
************************** **************************