From 6ecb97447b1a42495b7ec7873fd1b132b74437d8 Mon Sep 17 00:00:00 2001 From: samueldmcdermott Date: Mon, 23 Sep 2024 15:10:19 -0400 Subject: [PATCH] added index.rst for rtd build --- docs/source/index.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/source/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..ec9b136 --- /dev/null +++ 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