diff --git a/docs/_templates/autosummary/custom-class-template.rst b/docs/_templates/autosummary/custom-class-template.rst new file mode 100644 index 0000000..16ebb2f --- /dev/null +++ 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 %} \ No newline at end of file diff --git a/docs/_templates/autosummary/custom-module-template.rst b/docs/_templates/autosummary/custom-module-template.rst new file mode 100644 index 0000000..ef2c09a --- /dev/null +++ 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 %} \ No newline at end of file diff --git a/docs/_templates/autosummary/module.rst b/docs/_templates/autosummary/module.rst deleted file mode 100644 index 7a16b54..0000000 --- a/docs/_templates/autosummary/module.rst +++ /dev/null @@ -1,5 +0,0 @@ -{{ fullname }} -{{ underline }} - -.. automodule:: {{ fullname }} - :members: \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 4fa32e8..1fdcb0a 100644 --- 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 index 3bfeb5f..30c4a13 100644 --- 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 Installation - API Reference <_autosummary/diffusion_models> + API Reference Research \ No newline at end of file