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

**THIS SECTION IS UNDER CONSTRUCTION.**

If you have questions or would like to help please open an issue on GitHub_.

.. _GitHub: https://github.com/chaoss/augur/issues

These commands are used to build and view Augur's documentation.
Before making any documentation changes, please read the `documentation guide <../documentation.html>`_.

--------------------------

``make docs``
--------------
Generate both library and API documentation.

Example\:

.. code-block:: bash

  $ make docs

--------------------------

``make library-docs``
----------------------
Generate the library documentation (the documentation you're reading).

Example\:

.. code-block:: bash

  $ make library-docs

--------------------------

``make library-docs-view``
--------------------------
Generate the library documentation, and automatically open a new browser tab to view it.

Example\:

.. code-block:: bash

  $ make library-docs-view

--------------------------

``make api-docs``
------------------
Generate the API documentation.

Example\:

.. code-block:: bash

  $ make api-docs

--------------------------

``make api-docs-view``
-----------------------
Generate the API documentation, and automatically open a new browser tab to view it.

Example\:

.. code-block:: bash

  $ make api-docs-view