From ec5aecd3d6cd422a78df5225aead2952d04a04ee Mon Sep 17 00:00:00 2001 From: "Bryan W. Weber" Date: Sun, 4 Feb 2018 21:28:52 -0500 Subject: [PATCH] [Doc] Update example links in FAQ --- doc/sphinx/cxx-guide/simple-example.rst | 1 + doc/sphinx/cython/tutorial.rst | 2 +- doc/sphinx/faq.rst | 8 +++++++- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/sphinx/cxx-guide/simple-example.rst b/doc/sphinx/cxx-guide/simple-example.rst index 589574697..2c44cf87c 100644 --- a/doc/sphinx/cxx-guide/simple-example.rst +++ b/doc/sphinx/cxx-guide/simple-example.rst @@ -1,3 +1,4 @@ +.. _sec-cxx-simple-example: ************************* A Very Simple C++ Program diff --git a/doc/sphinx/cython/tutorial.rst b/doc/sphinx/cython/tutorial.rst index 823702581..888c6acd6 100644 --- a/doc/sphinx/cython/tutorial.rst +++ b/doc/sphinx/cython/tutorial.rst @@ -6,7 +6,7 @@ Tutorial Getting Started --------------- -Start by opening an interactive Python session, e.g. by running `IPython +Start by opening an interactive Python session, e.g., by running `IPython `_. Import the Cantera Python module and NumPy by running:: >>> import cantera as ct diff --git a/doc/sphinx/faq.rst b/doc/sphinx/faq.rst index 8ecf3d1fc..83335ac11 100644 --- a/doc/sphinx/faq.rst +++ b/doc/sphinx/faq.rst @@ -78,7 +78,13 @@ General **Where can I find examples of how to use Cantera?** - Cantera is distributed with many examples for the Python and Matlab + Examples of how to use Cantera are available in our online documentation. + For Python, visit the :ref:`sec-cython-examples` or the Jupyter Notebook + examples on `GitHub `_. For + Matlab visit the :ref:`sec-matlab-examples`, and for a simple C++ example + see :ref:`sec-cxx-simple-example`. + + In addition, Cantera is distributed with many examples for the Python and Matlab interfaces, and a smaller number of examples for the C++ and Fortran interfaces. The Matlab, C++, and Fortran examples should be installed in the ``samples`` subdirectory of the Cantera installation