added index.rst for rtd build

deepskies · Sep 23, 2024 · 6ecb974 · 6ecb974
1 parent 26d9bc1
commit 6ecb974
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,19 @@
+Welcome to DeepSZSim's documentation!
+===================================
+
+**DeepSZSim** offers fast simulation of clusters observed via the Sunyaev-Zel'dovich effect in the CMB.
+
+Check out the :doc:`usage` section for further information, including
+how to :ref:`installation` the project.
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+
+   usage
+   api