make doc build

judithabk6 · Feb 9, 2025 · b93cf22 · b93cf22
1 parent ab36036
commit b93cf22
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 29 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,19 +2,23 @@
 import sys
 
 import med_bench
-import med_bench.get_estimation
 import med_bench.get_simulated_data
-import med_bench.mediation
+import med_bench.estimation
+from med_bench.estimation.mediation_coefficient_product import CoefficientProduct
+from med_bench.estimation.mediation_dml import DoubleMachineLearning
+from med_bench.estimation.mediation_g_computation import GComputation
+from med_bench.estimation.mediation_ipw import InversePropensityWeighting
+from med_bench.estimation.mediation_mr import MultiplyRobust
+from med_bench.estimation.mediation_tmle import TMLE
 import med_bench.utils
 import med_bench.utils.utils
-import med_bench.utils.nuisances
 
 
 sys.path.insert(0, os.path.abspath('../'))
 
 project = 'med_bench'
-copyright = '2024, Judith Abecassis, Houssam Zenati, Bertrand Thirion, Hadrien Mariaccia, Mouad Zbakh'
-author = 'Judith Abecassis, Houssam Zenati, Bertrand Thirion, Hadrien Mariaccia, Mouad Zbakh'
+copyright = '2025, Judith Abecassis, Houssam Zenati, Bertrand Thirion, Hadrien Mariaccia, Mouad Zbakh, Sami Boumaïza, Julie Josse'
+author = 'Judith Abecassis, Houssam Zenati, Bertrand Thirion, Hadrien Mariaccia, Mouad Zbakh, Sami Boumaïza, Julie Josse'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -1,57 +1,68 @@
 .. toctree::
    :maxdepth: 4
-   :caption: Contents:
+   :caption: API:
 
 
-med_bench
-=================
-.. automodule:: med_bench
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
 
-get_estimation
---------
 
-.. automodule:: med_bench.get_estimation
+
+Estimation
+==========
+.. automodule:: med_bench.estimation
     :members:
     :undoc-members:
     :show-inheritance:
 
 
-get_simulated_data
---------
+.. automodule:: med_bench.estimation.mediation_coefficient_product
+    :members:
+    :undoc-members:
 
-.. automodule:: med_bench.get_simulated_data
+
+.. automodule:: med_bench.estimation.mediation_g_computation
     :members:
     :undoc-members:
-    :show-inheritance:
 
+.. automodule:: med_bench.estimation.mediation_ipw
+    :members:
+    :undoc-members:
 
-mediation
---------
 
-.. automodule:: med_bench.mediation
+.. automodule:: med_bench.estimation.mediation_mr
     :members:
     :undoc-members:
-    :show-inheritance:
 
 
-utils
---------
+.. automodule:: med_bench.estimation.mediation_dml
+    :members:
+    :undoc-members:
 
-.. automodule:: med_bench.utils.utils
+
+
+.. automodule:: med_bench.estimation.mediation_tmle
+    :members:
+    :undoc-members:
+
+
+
+get_simulated_data
+==========
+
+.. automodule:: med_bench.get_simulated_data
     :members:
     :undoc-members:
     :show-inheritance:
 
 
-nuisances
---------
+utils
+==========
 
-.. automodule:: med_bench.utils.nuisances
+.. automodule:: med_bench.utils.utils
     :members:
     :undoc-members:
     :show-inheritance:
 
+
+
+