=============
Documentation
=============

.. include:: ../../README.rst
   :start-after: -teaser-begin-
   :end-before: -teaser-end-

Overview
========

.. include:: ../../README.rst
   :start-after: -overview-begin-
   :end-before: -overview-end-

----

Full Table of Contents
======================

The User Guide
--------------

This part of the documentation, which is mostly prose, begins with some
background information about Clusterium, then focuses on step-by-step
instructions for getting the most out of Clusterium.

.. toctree::
   :maxdepth: 2

   installation
   usage

The Community Guide
-------------------

This part of the documentation, which is mostly prose, details the
Clusterium ecosystem and community.

.. toctree::
   :maxdepth: 2

   changelog

The API Documentation / Guide
-----------------------------

If you are looking for information on a specific function, class, method, or algorithm, this part of the documentation is for you.

.. toctree::
   :maxdepth: 3

   methodological_framework
   api

The Contributor Guide
---------------------

If you want to contribute to the project, this part of the documentation is for
you.

.. toctree::
   :maxdepth: 2

   maintainers
   contributing
   license

.. include:: ../../README.rst
   :start-after: -support-begin-
   :end-before: -support-end-

.. include:: ../../README.rst
   :start-after: -project-information-begin-
   :end-before: -project-information-end-

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`