:tocdepth: 3

.. _plasmapy-sphinx-documentation:

###############################
`plasmapy_sphinx` Documentation
###############################

`plasmapy_sphinx` is a
`Sphinx <https://www.sphinx-doc.org/en/master/>`__ extension package
that contains custom documentation functionality used to document
`PlasmaPy's packages <https://github.com/PlasmaPy>`_ .  This package is
organized in such a way that users can use all available extensions, or
just a selection of desired ones.

.. note::

    This package currently has no tests covering its
    functionality.


.. toctree::
    :caption: First Steps
    :maxdepth: 1

    Installation <first_steps/install>

.. toctree::
    :caption: Extensions
    :maxdepth: 1

    api_static/plasmapy_sphinx.ext.autodoc
    api_static/plasmapy_sphinx.ext.automodsumm
    api_static/plasmapy_sphinx.ext.css
    api_static/plasmapy_sphinx.ext.directives
    api_static/plasmapy_sphinx.theme

.. toctree::
    :caption: Contributor Guide
    :maxdepth: 1

.. toctree::
    :caption: All the Rest
    :maxdepth: 1

..    changelog/index