.. _installation_doc_generation:


Documentation Generation
========================

You can generate this documentation in your environment. For that purpose, you
need the `Sphinx <http://sphinx.pocoo.org/>`_ package.

.. code-block:: bash

    (virtualenv)$ pip install Sphinx

Now, in your source directory, type:

.. code-block:: bash

    (virtualenv)$ make -C Documentation/ html

Then, visit it with your favorite browser at
``Documentation/Build~/html/index.html``.

You can also generate PDF documentation and read it at
``Documentation/Build~/latex/publiforge.pdf``:

.. code-block:: bash

    (virtualenv)$ make -C Documentation/ latexpdf

Or ePub documentation:

.. code-block:: bash

    (virtualenv)$ make -C Documentation/ epub

Type ``make -C Documentation/`` for more information.