From 24f67874b34b88a2673b32ca032d85f9de06e062 Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Fri, 21 Jul 2023 19:34:09 -0600 Subject: [PATCH] [docs] Use doxylink to link content from Sphinx --- doc/doxygen/yaml.md | 6 +++--- doc/doxygen/yaml/yamltutorial.md | 2 +- doc/sphinx/yaml/index.rst | 1 + doc/sphinx/yaml/yaml_format.rst | 7 +++++++ interfaces/cython/cantera/_utils.pyx | 2 +- 5 files changed, 13 insertions(+), 5 deletions(-) create mode 100644 doc/sphinx/yaml/yaml_format.rst diff --git a/doc/doxygen/yaml.md b/doc/doxygen/yaml.md index 5b7acc6029..a076476b87 100644 --- a/doc/doxygen/yaml.md +++ b/doc/doxygen/yaml.md @@ -1,5 +1,8 @@ @page sec-yaml-documentation %Cantera YAML Documentation +> **Note:** %Cantera provides @ref sec-yaml-conversion to generate YAML files +> from Chemkin input data as well as legacy %Cantera formats. + This short guide describes %Cantera YAML input files that define phases and interfaces for use in %Cantera simulations. Each link below represents an entry point to the @subpage sec-yaml-api; while you certainly can read them in order, @@ -21,6 +24,3 @@ tips on troubleshooting the YAML file syntax rules, please look at the several types of homogeneous reactions, surface reactions, and electrochemical reactions. For each, there is a corresponding entry type. - -> **Note:** %Cantera provides @ref sec-yaml-conversion to generate YAML files -> from Chemkin input data as well as legacy %Cantera formats. diff --git a/doc/doxygen/yaml/yamltutorial.md b/doc/doxygen/yaml/yamltutorial.md index 4307fdc6f4..fa59929e55 100644 --- a/doc/doxygen/yaml/yamltutorial.md +++ b/doc/doxygen/yaml/yamltutorial.md @@ -180,7 +180,7 @@ A: 1.0e20 cm^6/mol^2-s # error ('s' should be in denominator) density: 3.0g/cm^3 # error (missing space between value and units) ``` -See the \ref sec-yaml-units documentation for additional details, +See the @ref sec-yaml-units documentation for additional details, including the full set of supported units. # Error Handling diff --git a/doc/sphinx/yaml/index.rst b/doc/sphinx/yaml/index.rst index 2c611a0858..2d4d2b048d 100644 --- a/doc/sphinx/yaml/index.rst +++ b/doc/sphinx/yaml/index.rst @@ -9,3 +9,4 @@ YAML Input File Converters cti_conversion ctml_conversion ck_conversion + yaml_format diff --git a/doc/sphinx/yaml/yaml_format.rst b/doc/sphinx/yaml/yaml_format.rst new file mode 100644 index 0000000000..7c5586b721 --- /dev/null +++ b/doc/sphinx/yaml/yaml_format.rst @@ -0,0 +1,7 @@ +******************* +Cantera YAML Format +******************* + +For information on the Cantera YAML format, refer to the +:ct:`Cantera YAML Documentation ` +on the Cantera Developer website. diff --git a/interfaces/cython/cantera/_utils.pyx b/interfaces/cython/cantera/_utils.pyx index a914da72c7..3480f88f60 100644 --- a/interfaces/cython/cantera/_utils.pyx +++ b/interfaces/cython/cantera/_utils.pyx @@ -174,7 +174,7 @@ cdef class AnyMap(dict): A key-value store representing objects defined in Cantera's YAML input format. Extends the capabilities of a normal `dict` object by providing functions for - converting values between different unit systems. See YAML Format Reference for + converting values between different unit systems. See :ct:`sec-yaml-units` for details on how units are handled in YAML input files. """ def __cinit__(self, *args, **kwawrgs):