Added sub directories to the user guide

MintonGroup · Feb 29, 2024 · 0f20025 · 0f20025
1 parent 91e2f3e
commit 0f20025
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -45,13 +45,13 @@ _dependencies
 !.readthedocs.yaml
 !docs/
 !docs/**/*
-docs/_build/
+!docs/_build/
 docs/_build/**/*
 docs/generated/
 docs/generated/**/*
 docs/**/*.DS_Store
 docs/**/*.swp
-docs/
+!docs/
 !docs/_static/**/*.png
 !docs/_static/**/*.svg
 **/*.ai
@@ -77,4 +77,4 @@ actions-runner*
 env/**
 venv/**
 
-sandbox/**
+sandbox/**
diff --git a/docs/user-guide/basic-simulation/index.rst b/docs/user-guide/basic-simulation/index.rst
@@ -0,0 +1,10 @@
+#################
+Basic Simulation
+#################
+
+Here, we will walk you through the basic features of Swiftest. 
+This is based on ``Basic_Simulation`` in ``swiftest/examples``.
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst
@@ -2,9 +2,11 @@
 User Guide
 ###########
 
-TBD
-
+In this user guide, you will find detailed descriptions and examples that describe the many capabilities of Swiftest and how to use them.
 
 .. toctree::
    :maxdepth: 2
    :hidden:
+
+   Basic Simulation <basic-simulation/index>
+   Spherical Harmonics <spherical-harmonics/index>
diff --git a/docs/user-guide/spherical-harmonics/index.rst b/docs/user-guide/spherical-harmonics/index.rst
@@ -0,0 +1,10 @@
+#################
+Spherical Harmonics
+#################
+
+Here, we show how to use Swiftest's Spherical Harmonics capabilities. 
+This is based on ``spherical_harmonics_cb`` in ``swiftest/examples``.
+
+.. toctree::
+   :maxdepth: 2
+   :hidden: