=============
API reference
=============

Top-level functions
===================

Primary functions used to interactively work with figures. Modeled after the
`~matplotlib.pyplot` versions.

.. automodsumm:: proplot.subplots
   :functions-only:
   :toctree: api

Figure classes
==============

The figure class and a couple related classes.

.. automodsumm:: proplot.subplots
   :classes-only:
   :toctree: api

Axes classes
============

.. automodule:: proplot.axes

.. automodsumm:: proplot.axes
   :toctree: api
   :classes-only:

Plotting wrappers
=================

.. automodule:: proplot.wrappers

.. automodsumm:: proplot.wrappers
   :toctree: api
   :functions-only:

Projection tools
================

.. automodule:: proplot.projs

.. rubric:: Variables

.. automodsumm:: proplot.projs
   :variables-only:
   :toctree: api

.. rubric:: Functions

.. automodsumm:: proplot.projs
   :functions-only:
   :toctree: api

.. rubric:: Classes

.. automodsumm:: proplot.projs
   :classes-only:
   :toctree: api

Axis tools
==========

.. automodule:: proplot.axistools

.. rubric:: Variables

.. automodsumm:: proplot.axistools
   :toctree: api
   :variables-only:

.. rubric:: Functions

.. automodsumm:: proplot.axistools
   :toctree: api
   :functions-only:

.. rubric:: Classes

.. automodsumm:: proplot.axistools
   :toctree: api
   :classes-only:

Color and font tools
====================

.. automodule:: proplot.styletools

.. rubric:: Variables

.. automodsumm:: proplot.styletools
   :variables-only:
   :toctree: api

.. rubric:: Functions

.. automodsumm:: proplot.styletools
   :functions-only:
   :toctree: api

.. rubric:: Classes

.. automodsumm:: proplot.styletools
   :classes-only:
   :toctree: api

Rc configuration tools
======================

.. automodule:: proplot.rctools

.. automodsumm:: proplot.rctools
   :toctree: api

Miscellaneous tools
===================

.. automodule:: proplot.utils

.. automodsumm:: proplot.utils
   :functions-only:
   :toctree: api
