Skip to content

Commit

Permalink
More tidying
Browse files Browse the repository at this point in the history
  • Loading branch information
coretl committed Jan 9, 2024
1 parent b370222 commit 5e61288
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 13 deletions.
3 changes: 3 additions & 0 deletions docs/genindex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Index

<!-- Placeholder that sphinx will replace with a generated index -->
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,39 +20,39 @@ top bar.
::::{grid} 2
:gutter: 4

:::{grid-item-card} {material-regular}`directions_walk;2em`
:::{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.
:::

Expand Down
9 changes: 1 addition & 8 deletions docs/reference.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
orphan: true
---

# Reference

Technical reference material including APIs and release notes.
Expand All @@ -12,8 +8,5 @@ Technical reference material including APIs and release notes.
reference/api
reference/rest_api
reference/contributing
Index <genindex.html#http://>
genindex
```

% Index link above is a hack to make genindex.html a relative link
% https://stackoverflow.com/a/31820846

0 comments on commit 5e61288

Please sign in to comment.