Merge pull request #112 from freegs-plasma/docs-refresh

Docs refresh
freegs-plasma · Aug 19, 2024 · c1b4f14 · c1b4f14
2 parents 4e805d4 + 07a3fe5
commit c1b4f14
Show file tree

Hide file tree

Showing 58 changed files with 528 additions and 608 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ venv
 freegs/_version.py
 asv_bench/.asv/
 docs/_build
+docs/generated
diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst
@@ -0,0 +1,32 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+   {% 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/custom-module-template.rst b/docs/_templates/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/api.rst b/docs/api.rst
@@ -0,0 +1,10 @@
+===============
+ API Reference
+===============
+
+.. autosummary::
+   :toctree: generated
+   :template: custom-module-template.rst
+   :recursive:
+
+   freegs
diff --git a/docs/api/freegs.boundary.rst b/docs/api/freegs.boundary.rst
diff --git a/docs/api/freegs.coil.rst b/docs/api/freegs.coil.rst
diff --git a/docs/api/freegs.control.rst b/docs/api/freegs.control.rst
diff --git a/docs/api/freegs.critical.rst b/docs/api/freegs.critical.rst
diff --git a/docs/api/freegs.divgeo.rst b/docs/api/freegs.divgeo.rst
diff --git a/docs/api/freegs.dump.rst b/docs/api/freegs.dump.rst
diff --git a/docs/api/freegs.equilibrium.rst b/docs/api/freegs.equilibrium.rst
diff --git a/docs/api/freegs.fieldtracer.rst b/docs/api/freegs.fieldtracer.rst
diff --git a/docs/api/freegs.filament_coil.rst b/docs/api/freegs.filament_coil.rst
diff --git a/docs/api/freegs.geqdsk.rst b/docs/api/freegs.geqdsk.rst
diff --git a/docs/api/freegs.gradshafranov.rst b/docs/api/freegs.gradshafranov.rst
diff --git a/docs/api/freegs.jtor.rst b/docs/api/freegs.jtor.rst
diff --git a/docs/api/freegs.machine.rst b/docs/api/freegs.machine.rst
diff --git a/docs/api/freegs.multi_coil.rst b/docs/api/freegs.multi_coil.rst
diff --git a/docs/api/freegs.multigrid.rst b/docs/api/freegs.multigrid.rst
diff --git a/docs/api/freegs.optimise.rst b/docs/api/freegs.optimise.rst
diff --git a/docs/api/freegs.optimiser.rst b/docs/api/freegs.optimiser.rst
diff --git a/docs/api/freegs.picard.rst b/docs/api/freegs.picard.rst
diff --git a/docs/api/freegs.plotting.rst b/docs/api/freegs.plotting.rst
diff --git a/docs/api/freegs.polygons.rst b/docs/api/freegs.polygons.rst
diff --git a/docs/api/freegs.pre_calc_coil.rst b/docs/api/freegs.pre_calc_coil.rst
diff --git a/docs/api/freegs.quadrature.rst b/docs/api/freegs.quadrature.rst
diff --git a/docs/api/freegs.rst b/docs/api/freegs.rst
diff --git a/docs/api/freegs.shaped_coil.rst b/docs/api/freegs.shaped_coil.rst
diff --git a/docs/api/freegs.test_critical.rst b/docs/api/freegs.test_critical.rst
diff --git a/docs/api/freegs.test_equilibrium.rst b/docs/api/freegs.test_equilibrium.rst
diff --git a/docs/api/freegs.test_filament_coil.rst b/docs/api/freegs.test_filament_coil.rst
diff --git a/docs/api/freegs.test_jtor.rst b/docs/api/freegs.test_jtor.rst
diff --git a/docs/api/freegs.test_linearsolve.rst b/docs/api/freegs.test_linearsolve.rst
diff --git a/docs/api/freegs.test_machine.rst b/docs/api/freegs.test_machine.rst