Skip to content

Commit

Permalink
[Doc] Add separate top-level pages for examples and reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
speth committed Sep 23, 2023
1 parent 9761c98 commit ec41c38
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 34 deletions.
12 changes: 0 additions & 12 deletions doc/sphinx/_templates/cantera-org-links.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@
</a>
</li>

<li class="nav-item">
<a class="nav-link nav-internal" href="/examples/index.html">
Examples
</a>
</li>

<li class="nav-item">
<a class="nav-link nav-internal" href="/community.html">
Community
Expand All @@ -29,12 +23,6 @@
</a>
</li>

<li class="nav-item current active">
<a class="nav-link nav-internal" href="/documentation/index.html">
Documentation
</a>
</li>

<li class="nav-item">
<a class="nav-link nav-internal" href="/blog/index.html">
Blog
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ def escape_splats(app, what, name, obj, options, lines):

html_theme_options = {
"show_toc_level": 2,
"navbar_center": ["cantera-org-links"],
"navbar_center": ["cantera-org-links", "navbar-nav"],
"navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
"logo": {
"link": "/index.html",
Expand Down
16 changes: 16 additions & 0 deletions doc/sphinx/documentation.rst
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>`__
21 changes: 21 additions & 0 deletions doc/sphinx/examples.rst
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
26 changes: 5 additions & 21 deletions doc/sphinx/index.rst
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

0 comments on commit ec41c38

Please sign in to comment.