added some docs files

deepskies · Sep 23, 2024 · 60239f4 · 60239f4
1 parent 5f7324d
commit 60239f4
Show file tree

Hide file tree

Showing 2 changed files with 108 additions and 0 deletions.
diff --git a/docs/source/deepszsim.rst b/docs/source/deepszsim.rst
@@ -0,0 +1,101 @@
+deepszsim package
+=================
+
+Submodules
+----------
+
+deepszsim.dm\_halo\_dist module
+-------------------------------
+
+.. automodule:: deepszsim.dm_halo_dist
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.filters module
+------------------------
+
+.. automodule:: deepszsim.filters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.io\_params module
+---------------------------
+
+.. automodule:: deepszsim.io_params
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.load\_vars module
+---------------------------
+
+.. automodule:: deepszsim.load_vars
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.make\_sz\_cluster module
+----------------------------------
+
+.. automodule:: deepszsim.make_sz_cluster
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.noise module
+----------------------
+
+.. automodule:: deepszsim.noise
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.read\_yaml module
+---------------------------
+
+.. automodule:: deepszsim.read_yaml
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.simclusters module
+----------------------------
+
+.. automodule:: deepszsim.simclusters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.simtools module
+-------------------------
+
+.. automodule:: deepszsim.simtools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.utils module
+----------------------
+
+.. automodule:: deepszsim.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepszsim.visualization module
+------------------------------
+
+.. automodule:: deepszsim.visualization
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: deepszsim
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+deepszsim
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   deepszsim