updated docs

liopeer · Sep 2, 2023 · f3d31bd · f3d31bd
1 parent f6d94e1
commit f3d31bd
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 8 deletions.
diff --git a/docs/_templates/autosummary/custom-class-template.rst b/docs/_templates/autosummary/custom-class-template.rst
@@ -0,0 +1,32 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
diff --git a/docs/_templates/autosummary/custom-module-template.rst b/docs/_templates/autosummary/custom-module-template.rst
@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
diff --git a/docs/_templates/autosummary/module.rst b/docs/_templates/autosummary/module.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'diffusion_models'
+project = 'DiffusionMRI'
 copyright = '2023, Lionel Peer'
 author = 'Lionel Peer'
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,7 +7,7 @@ Diffusion Models for MRI
 ========================
 This Python library is being created as part of a thesis in the fall semester of 2023
 at ETH Zurich. It offers everything to get you started on conditional reconstruction
-of MRI acquisitions using diffusion models.
+of accelerated MRI acquisitions using denoising diffusion probabilistic models (DDPMs).
 
 .. note::
    Not yet under development. We're only setting things up.
@@ -17,5 +17,5 @@ of MRI acquisitions using diffusion models.
 
    Homepage <self>
    Installation <installation>
-   API Reference <_autosummary/diffusion_models>
+   API Reference <api>
    Research <chap/tex_stuff>