API Documentation
=================

The complete Java API reference documentation is generated from source code
comments using Javadoc. It covers all public classes and interfaces in the
Panacea modules.

`View the Java API Documentation (Javadoc) <javadoc/index.html>`_

The Javadoc is aggregated from all modules:


Referencing Java Types
----------------------

Within this documentation, Java types from Panacea can be referenced using
the ``java:`` domain provided by the ``javasphinx`` Sphinx extension. For
example:

.. code-block:: rst

   :java:type:`org.javastro.panacea.Job`

Cross-references like this link directly to the relevant section of the
aggregated Javadoc.