Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs refresh #112

Merged
merged 7 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ venv
freegs/_version.py
asv_bench/.asv/
docs/_build
docs/generated
32 changes: 32 additions & 0 deletions docs/_templates/custom-class-template.rst
Original file line number Diff line number Diff line change
@@ -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 %}
66 changes: 66 additions & 0 deletions docs/_templates/custom-module-template.rst
Original file line number Diff line number Diff line change
@@ -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 %}
10 changes: 10 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
===============
API Reference
===============

.. autosummary::
:toctree: generated
:template: custom-module-template.rst
:recursive:

freegs
7 changes: 0 additions & 7 deletions docs/api/freegs.boundary.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.coil.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.control.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.critical.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.divgeo.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.dump.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.equilibrium.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.fieldtracer.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.filament_coil.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.geqdsk.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.gradshafranov.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.jtor.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.machine.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.multi_coil.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.multigrid.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.optimise.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.optimiser.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.picard.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.plotting.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.polygons.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.pre_calc_coil.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.quadrature.rst

This file was deleted.

50 changes: 0 additions & 50 deletions docs/api/freegs.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.shaped_coil.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.test_critical.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.test_equilibrium.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.test_filament_coil.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.test_jtor.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.test_linearsolve.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/api/freegs.test_machine.rst

This file was deleted.

Loading
Loading