Skip to content

Commit

Permalink
[docs] Update mainpage
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl committed Jul 20, 2023
1 parent e1e6708 commit 7c3a01c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
5 changes: 2 additions & 3 deletions doc/doxygen/mainpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

> **Note:** This is the **%Cantera Developer API** documentation; for general
> information on %Cantera, refer to [**cantera.org**](https://cantera.org).
> The %Cantera source code is hosted on [GitHub](https://github.com/Cantera/cantera).
Use sidebar or menu at the top to view detailed documentation of the code, or
use the following shortcuts:
Expand All @@ -10,7 +11,7 @@ use the following shortcuts:
* Index of [**Cantera C++ Classes**](classes.html)
* \ref sec-yaml-documentation

A topical overview is provided as follows:
A topical overview of C++ modules is provided as follows:

* \ref solnGroup (interface to %Cantera core objects)
* \ref thermoprops (temperature, pressure, energy, ...)
Expand All @@ -23,5 +24,3 @@ A topical overview is provided as follows:
For fundamental scientific theory used for the implementation of %Cantera, refer to the
[Cantera Science Section](https://cantera.org/science/index.html) of the
[Cantera Website](https://cantera.org).

The %Cantera source code is hosted on [GitHub](https://github.com/Cantera/cantera).
2 changes: 1 addition & 1 deletion interfaces/cython/cantera/_utils.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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 :ref:`sec-yaml-units` for
converting values between different unit systems. See YAML Format Reference for
details on how units are handled in YAML input files.
"""
def __cinit__(self, *args, **kwawrgs):
Expand Down

0 comments on commit 7c3a01c

Please sign in to comment.