.. _api_funcs:

API documentation
=================

The documentation is under development while we are restructuring the codebase.
Parts the are being moved to the new structure are directly below this line.

.. note:: For reference, we are keeping a pinned issue on GitHub describing the
          restructuring process and the reasoning behind it.
          See :issue:`190` for more details.

New structure
-------------

.. toctree::
    :maxdepth: 3
    :glob:

    specfem/index


Old structure
-------------

.. toctree::
    :maxdepth: 2

    algorithms/index
    boundary_conditions/index
    enumerations/index
    quadrature/index
    mesh/index
    datatypes/index
    execution/index
    medium/index
    kokkos_kernels/index
    coupling_physics/coupled_interface
    setup_parameters/index
    macros/index
    parallel_configuration/index