.. PyRADS documentation master file, created by
sphinx-quickstart on Fri Nov 2 10:30:09 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. only:: html
.. image:: _static/logo_black.svg
:align: center
Python access to RADS
=====================
Get this documentation as a download in several formats:
* `PDF `_
* `HTMLZip `_
* `Epub `_
User Guide
----------
Work in progress, see the README_ for now.
.. _README: https://github.com/ccarocean/pyrads/blob/master/README.rst
API Documentation
-----------------
If you are looking for information on a specific function, class, or method, this part of the documentation is for you, in particular :ref:`public_api`.
.. toctree::
:maxdepth: 3
api/rads
.. note::
Cross reference links in this section will always link to the private API section below due to limitations with Sphinx.
Contributor Guide
-----------------
.. toctree::
:maxdepth: 2
api/private
Indices and Tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`