-
-
Notifications
You must be signed in to change notification settings - Fork 347
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Doc] Add separate top-level pages for examples and reference docs
- Loading branch information
Showing
5 changed files
with
43 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
|
||
Reference | ||
========= | ||
|
||
This pages provide detailed reference documentation for Cantera. | ||
|
||
.. toctree:: | ||
:caption: API Documentation | ||
:maxdepth: 1 | ||
|
||
yaml/index | ||
cython/index | ||
matlab/index | ||
|
||
|
||
`C++ API Documentation <../../doxygen/html/index.html>`__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Examples | ||
======== | ||
|
||
Cantera includes examples for a number of applications. To see all examples written in a | ||
particular programming language, select the corresponding category below. Or, to browse | ||
all examples covering a particular topic, regardless of programming language, select | ||
from the :ref:`list of example tags <tagoverview>`. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
examples/python/index | ||
examples/cxx/index | ||
examples/clib/index | ||
examples/matlab_experimental/index | ||
examples/fortran/index | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
_tags/tagsindex |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,8 @@ | ||
.. Cantera documentation master file, created by | ||
sphinx-quickstart on Mon Mar 12 11:43:09 2012. | ||
Documentation | ||
============= | ||
|
||
These are the detailed API documentation pages for the Python and Matlab | ||
interfaces for Cantera. There is also documentation of the YAML input file | ||
format. | ||
Table of Contents | ||
================= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
yaml/index | ||
cython/index | ||
matlab/index | ||
|
||
examples/python/index | ||
examples/cxx/index | ||
examples/clib/index | ||
examples/matlab_experimental/index | ||
examples/fortran/index | ||
:maxdepth: 1 | ||
|
||
_tags/tagsindex | ||
documentation | ||
examples |