Docs

.readthedocs.yaml

@@ -0,0 +1,30 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+# Set the OS, Python version, and other tools
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+# Optional: include PDF and ePub outputs
+formats:
+  - pdf
+
+# Install dependencies
+python:
+  install:
+    # Install docs requirements
+    - requirements: docs/requirements.txt
+    # Install the package itself (without external FRB deps for docs)
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/Makefile

@@ -0,0 +1,18 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.rst

@@ -0,0 +1,152 @@
+.. _api:
+
+=============
+API Reference
+=============
+
+This section provides detailed API documentation for all public modules
+and classes in the ``zdm`` package.
+
+Core Modules
+============
+
+parameters
+----------
+
+.. automodapi:: zdm.parameters
+   :no-inheritance-diagram:
+
+survey
+------
+
+.. automodapi:: zdm.survey
+   :no-inheritance-diagram:
+
+grid
+----
+
+.. automodapi:: zdm.grid
+   :no-inheritance-diagram:
+
+repeat_grid
+-----------
+
+.. automodapi:: zdm.repeat_grid
+   :no-inheritance-diagram:
+
+Computation Modules
+===================
+
+cosmology
+---------
+
+.. automodapi:: zdm.cosmology
+   :no-inheritance-diagram:
+
+pcosmic
+-------
+
+.. automodapi:: zdm.pcosmic
+   :no-inheritance-diagram:
+
+energetics
+----------
+
+.. automodapi:: zdm.energetics
+   :no-inheritance-diagram:
+
+iteration
+---------
+
+.. automodapi:: zdm.iteration
+   :no-inheritance-diagram:
+
+Utility Modules
+===============
+
+loading
+-------
+
+.. automodapi:: zdm.loading
+   :no-inheritance-diagram:
+
+misc_functions
+--------------
+
+.. automodapi:: zdm.misc_functions
+   :no-inheritance-diagram:
+
+figures
+-------
+
+.. automodapi:: zdm.figures
+   :no-inheritance-diagram:
+
+beams
+-----
+
+.. automodapi:: zdm.beams
+   :no-inheritance-diagram:
+
+Analysis Modules
+================
+
+MCMC
+----
+
+.. automodapi:: zdm.MCMC
+   :no-inheritance-diagram:
+
+MCMC_analysis
+-------------
+
+.. automodapi:: zdm.MCMC_analysis
+   :no-inheritance-diagram:
+
+analyze_cube
+------------
+
+.. automodapi:: zdm.analyze_cube
+   :no-inheritance-diagram:
+
+vvmax
+-----
+
+.. automodapi:: zdm.vvmax
+   :no-inheritance-diagram:
+
+Data Classes
+============
+
+data_class
+----------
+
+.. automodapi:: zdm.data_class
+   :no-inheritance-diagram:
+
+survey_data
+-----------
+
+.. automodapi:: zdm.survey_data
+   :no-inheritance-diagram:
+
+Specialized Modules
+===================
+
+galactic_dm_models
+------------------
+
+.. automodapi:: zdm.galactic_dm_models
+   :no-inheritance-diagram:
+
+optical
+-------
+
+.. automodapi:: zdm.optical
+   :no-inheritance-diagram:
+
+io
+--
+
+.. automodapi:: zdm.io
+   :no-inheritance-diagram: