diff --git a/.gitignore b/.gitignore index 67541a087..a2e8f50fc 100644 --- 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/** \ No newline at end of file +sandbox/** diff --git a/docs/user-guide/basic-simulation/index.rst b/docs/user-guide/basic-simulation/index.rst new file mode 100644 index 000000000..178f9bfb6 --- /dev/null +++ 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: \ No newline at end of file diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst index b63a21e90..6b79531cf 100644 --- 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 + Spherical Harmonics \ No newline at end of file diff --git a/docs/user-guide/spherical-harmonics/index.rst b/docs/user-guide/spherical-harmonics/index.rst new file mode 100644 index 000000000..456312d26 --- /dev/null +++ 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: \ No newline at end of file