docs: add emojis to homepage

mdtanker · Nov 27, 2023 · eda2938 · eda2938
1 parent ef58202
commit eda2938
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 8 deletions.
diff --git a/docs/gallery/index.md b/docs/gallery/index.md
@@ -1,4 +1,4 @@
-# Gallery
+#
 
 ```{warning}
 Gallery examples still to come ...

diff --git a/docs/index.md b/docs/index.md
@@ -3,16 +3,14 @@
 ```{toctree}
 :maxdepth: 1
 :hidden:
-:caption: Getting Started
 overview
 install
-gallery/index
 ```
 
 ```{toctree}
 :maxdepth: 1
 :hidden:
-:caption: User guide
+:caption: 🚶 User guide
 user_guide/simple_inversion
 user_guide/damping_cross_validation
 user_guide/density_cross_validation
@@ -21,19 +19,27 @@ user_guide/including_starting_model
 user_guide/adhering_to_constraints
 ```
 
+```{toctree}
+:maxdepth: 1
+:hidden:
+:caption: 📚 Gallery
+gallery/index.md
+```
+
 ```{toctree}
 :maxdepth: 2
 :hidden:
-:caption: Reference documentation
+:caption: 📖 Reference documentation
 api/invert4geom
 citing.md
 changelog.md
+references.md
 ```
 
 ```{toctree}
 :maxdepth: 1
 :hidden:
-:caption: Other resources
+:caption: ℹ️ Other resources
 How to contribute <https://github.com/mdtanker/invert4geom/blob/main/.github/CONTRIBUTING.md>
 Source code on GitHub <https://github.com/mdtanker/invert4geom>
 ```

diff --git a/docs/install.md b/docs/install.md
@@ -1,4 +1,4 @@
-# Install
+# 🚀 Install
 
 There are 3 main ways to install `invert4geom`. We show them here in order of
 simplest to hardest.

diff --git a/docs/overview.md b/docs/overview.md
@@ -1,4 +1,4 @@
-# Overview
+# 🔎 Overview
 
 Invert4geom provides a series of tools for conducting a specific style of
 gravity inversion. Many gravity inversions aim to model the density distribution