Skip to content

Commit 6a2e036

Browse files
committed
[Doc] Add more stub pages to the Sphinx docs
1 parent ac56e4c commit 6a2e036

File tree

5 files changed

+62
-8
lines changed

5 files changed

+62
-8
lines changed

Diff for: doc/sphinx/reference/glossary.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Glossary
2+
3+
4+
```{caution}
5+
This page is a work in progress. Please see
6+
<a href="/documentation/glossary.html">this page</a> for current documentation.
7+
```

Diff for: doc/sphinx/reference/index.md

+21-7
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@ mechanism files.
1919
````{grid} 2
2020
:gutter: 3
2121
22-
```{grid-item-card} YAML Format Reference
23-
:link: /yaml/index
24-
:link-type: doc
25-
:text-align: center
26-
```
27-
2822
```{grid-item-card} Python API Reference
2923
:link: /python/index
3024
:link-type: doc
@@ -42,16 +36,29 @@ mechanism files.
4236
:text-align: center
4337
```
4438
39+
```{grid-item-card} YAML Format Reference
40+
:link: /yaml/index
41+
:link-type: doc
42+
:text-align: center
43+
```
44+
45+
```{grid-item-card} Release Notes
46+
:link: releasenotes/index
47+
:link-type: doc
48+
:text-align: center
49+
```
50+
4551
````
4652

4753
```{toctree}
4854
:hidden:
4955
:maxdepth: 1
5056
:caption: API Reference
5157
52-
/yaml/index
5358
/python/index
5459
/matlab/index
60+
/yaml/index
61+
releasenotes/index
5562
```
5663

5764
## Science Reference
@@ -74,6 +81,12 @@ methods implemented by Cantera
7481
:text-align: center
7582
```
7683
84+
```{grid-item-card} Glossary
85+
:link: glossary
86+
:link-type: doc
87+
:text-align: center
88+
```
89+
7790
````
7891

7992
```{toctree}
@@ -83,4 +96,5 @@ methods implemented by Cantera
8396
8497
science/reactors/index
8598
bibliography
99+
glossary
86100
```

Diff for: doc/sphinx/reference/releasenotes/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Release Notes
2+
3+
```{caution}
4+
This page is a work in progress. Please see
5+
<a href="/documentation/index.html">this page</a> for current documentation.
6+
```

Diff for: doc/sphinx/userguide/faq.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Frequently Asked Questions
2+
3+
```{caution}
4+
This page is a work in progress. Sorry.
5+
```
6+
7+
## Installation
8+
9+
## Input Files
10+
* Where can I find chemical mechanisms to use with Cantera?
11+
* How do I fix errors converting Chemkin input files to Cantera's format?

Diff for: doc/sphinx/userguide/index.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,29 @@ release (Cantera 3.0), please see <a href="/tutorials/index.html">this page</a>.
77

88
## Introductory Tutorials
99

10+
For those new to Cantera, we present here a set of short tutorials to familiarize you
11+
with Cantera's basic functionality and capabilities, give some examples of how to work
12+
Cantera within your preferred interface language, and demonstrate some basic
13+
troubleshooting.
1014

1115
{doc}`Getting Started with Python <python-tutorial>`
1216

13-
* Task/goal-oriented guides
17+
## Frequently asked questions
18+
19+
See the {doc}`FAQ <faq>` for answers to some common issues that arise when using
20+
Cantera. If your question isn't answered here, consider asking us on the
21+
<a href="https://cantera.org/community.html#the-cantera-users-group">Cantera Users' Group</a>.
22+
23+
## Task Guides
24+
25+
The tutorials in this section are designed to help you accomplish a specific task
26+
using Cantera, such as evaluating the ignition delay time for a fuel under different
27+
conditions, or calculating the voltage of a Lithium-ion battery as it is discharged.
28+
1429

1530
```{toctree}
1631
:hidden:
1732
1833
python-tutorial
34+
faq
1935
```

0 commit comments

Comments
 (0)