-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.md
58 lines (46 loc) · 1.07 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
---
html_theme.sidebar_secondary.remove: true
---
```{include} ../README.md
:end-before: <!-- README only content
```
[plot]: images/plot_spec.png
How the documentation is structured
-----------------------------------
Documentation is split into [four categories](https://diataxis.fr), also accessible from links in the top bar.
<!-- https://sphinx-design.readthedocs.io/en/latest/grids.html -->
::::{grid} 2
:gutter: 4
:::{grid-item-card} {material-regular}`directions_walk;2em`
```{toctree}
:maxdepth: 2
tutorials
```
+++
Tutorials for installation and typical usage. New users start here.
:::
:::{grid-item-card} {material-regular}`directions;2em`
```{toctree}
:maxdepth: 2
how-to
```
+++
Practical step-by-step guides for the more experienced user.
:::
:::{grid-item-card} {material-regular}`info;2em`
```{toctree}
:maxdepth: 2
explanations
```
+++
Explanations of how it works and why it works that way.
:::
:::{grid-item-card} {material-regular}`menu_book;2em`
```{toctree}
:maxdepth: 2
reference
```
+++
Technical reference material including APIs and release notes.
:::
::::