Commit 04a45de9 authored by Mihai Baltac's avatar Mihai Baltac

Using better-apidoc to generate templated package and module documentation;...

Using better-apidoc to generate templated package and module documentation; added generation templates
parent d5d5c2f5
Pipeline #24796 passed with stages
in 3 minutes and 54 seconds
......@@ -31,9 +31,9 @@ pages:
script:
- pip install sphinx
- pip install sphinx_rtd_theme
- pip install better-apidoc
- pip install numpydoc
- sphinx-apidoc -l -e -d 3 -o docs/source/mod nifty4
- sphinx-build -b html docs/source/ docs/build/
- sh docs/generate.sh
- mv docs/build/ public/
artifacts:
paths:
......
This diff is collapsed.
rm -rf docs/build docs/source/mod
sphinx-apidoc -l -e -d 3 -o docs/source/mod nifty4
better-apidoc -l -e -d 2 -t docs/generation-templates -o docs/source/mod nifty4
sphinx-build -b html docs/source/ docs/build/
{% if name %}
{{ name }}
{% for item in range(8 + name|length) -%}={%- endfor %}
{% else %}
{{ fullname }}
{% for item in range(8 + fullname|length) -%}={%- endfor %}
({{ fullname }} module)
{% endif %}
.. currentmodule:: {{ fullname }}
.. automodule:: {{ fullname }}
{% if members -%}
:members: {{ members|join(", ") }}
:undoc-members:
:show-inheritance:
:member-order: bysource
Summary
-------
{% if doc:%}
{{doc}}
{% endif %}
{%- if exceptions %}
Exceptions:
.. autosummary::
:nosignatures:
{% for item in exceptions %}
{{ item }}
{%- endfor %}
{%- endif %}
{%- if classes %}
Classes:
.. autosummary::
:nosignatures:
{% for item in classes %}
{{ item }}
{%- endfor %}
{%- endif %}
{%- if functions %}
Functions:
.. autosummary::
:nosignatures:
{% for item in functions %}
{{ item }}
{%- endfor %}
{%- endif %}
{%- endif %}
{%- if data %}
Data:
.. autosummary::
:nosignatures:
{% for item in data %}
{{ item }}
{%- endfor %}
{%- endif %}
{% if all_refs %}
``__all__``: {{ all_refs|join(", ") }}
{%- endif %}
{% if members %}
Reference
---------
{%- endif %}
\ No newline at end of file
{% if name %}
{{ name }}
{% for item in range(8 + name|length) -%}={%- endfor %}
({{ fullname }} package)
{% else %}
{{ fullname }}
{% for item in range(8 + fullname|length) -%}={%- endfor %}
({{ fullname }} package)
{% endif %}
.. automodule:: {{ fullname }}
{% if members -%}
:members: {{ members|join(", ") }}
:undoc-members:
:show-inheritance:
{%- endif %}
{% if submodules %}
Submodules:
.. toctree::
:maxdepth: 1
{% for item in submodules %}
{{ fullname }}.{{ item }}
{%- endfor %}
{%- endif -%}
{% if subpackages %}
Subpackages:
.. toctree::
:maxdepth: 1
{% for item in subpackages %}
{{ fullname }}.{{ item }}
{%- endfor %}
{%- endif %}
{% if members or doc %}
Summary
-------
{% if doc:%}
{{doc}}
{% endif %}
{%- if exceptions %}
Exceptions:
.. autosummary::
:nosignatures:
{% for item in exceptions %}
{{ item }}
{%- endfor %}
{%- endif %}
{%- if classes %}
Classes:
.. autosummary::
:nosignatures:
{% for item in classes %}
{{ item }}
{%- endfor %}
{%- endif %}
{%- if functions %}
Functions:
.. autosummary::
:nosignatures:
{% for item in functions %}
{{ item }}
{%- endfor %}
{%- endif %}
{%- endif %}
{%- if data %}
Data:
.. autosummary::
:nosignatures:
{% for item in data %}
{{ item }}
{%- endfor %}
{%- endif %}
{% if all_refs %}
``__all__``: {{ all_refs|join(", ") }}
{%- endif %}
{% if members %}
Reference
---------
{%- endif %}
\ No newline at end of file
......@@ -5,7 +5,7 @@ The NIFTy code is divided in the concepts Spaces, Fields, Operators and Minimiza
.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Concepts
:glob:
......
......@@ -4,6 +4,7 @@ Fields
Description of Fields
.. toctree::
:maxdepth: 1
:caption: Types of Fields
Field <../mod/nifty4.field>
......
......@@ -4,6 +4,7 @@ Minimization
Description of Minimization
.. toctree::
:maxdepth: 1
:caption: Minimization Concepts
Conjugate Gradient <../mod/nifty4.minimization.conjugate_gradient>
......
......@@ -4,6 +4,7 @@ Operators
Description of Operators
.. toctree::
:maxdepth: 1
:caption: Types of Operators
Adjoint <../mod/nifty4.operators.adjoint_operator>
......
......@@ -4,6 +4,7 @@ Spaces
Description of Spaces
.. toctree::
:maxdepth: 1
:caption: Types of Spaces
DOF <../mod/nifty4.spaces.dof_space>
......
"""
Sample documentation for spaces. (or any other package) This will be displayed under Summary section of module documentation
"""
......@@ -16,6 +16,10 @@
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.
"""
Sample documentation for DOF space. (or any other module). This will be displayed under Summary section of module documentation
"""
import numpy as np
from .structured_domain import StructuredDomain
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment