diff --git a/docs/genindex.md b/docs/genindex.md new file mode 100644 index 00000000..73f1191b --- /dev/null +++ b/docs/genindex.md @@ -0,0 +1,3 @@ +# Index + + diff --git a/docs/index.md b/docs/index.md index 4229d146..64390f0d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. ::: diff --git a/docs/reference.md b/docs/reference.md index 888a455c..83a03333 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,7 +1,3 @@ ---- -orphan: true ---- - # Reference Technical reference material including APIs and release notes. @@ -12,8 +8,5 @@ Technical reference material including APIs and release notes. reference/api reference/rest_api reference/contributing -Index +genindex ``` - -% Index link above is a hack to make genindex.html a relative link -% https://stackoverflow.com/a/31820846