source: main/waeup.sirp/trunk/docs/source/userdocs/buildingdocs.rst @ 5343

.. _building_documentation:

Building Documentation
**********************

To build the documentation for :mod:`waeup.sirp`, please follow these steps:

Prerequisites
=============

We assume you already installed `waeup.sirp` as explained in
:ref:`installing`. You ran ``bin/buildout`` and can find a script
``bin/waeupdocs``.

Building HTML docs
==================

After successful install go to the root dir, where `waeup.sirp` is
located.

There run::

   $ ./bin/waeupdocs

This will (re-)generate any needed docs.

The output can be found in ``docs/build/html``.

Alternatively, you can also go to ``docs/build`` and run::

   $ make html

Actually, ``waeupdocs`` is only a wrapper script around the real main
script ``sphinx-build``, which should also be located in your ``bin/``
directory.

You therefore can also run ``bin/spinx-build`` manually, which will
give you more options, especially, if you want the output to be
created in a different location or similar.

Building PDF docs
=================

We're currently not prepared for PDF, but support is already planned.

Please be aware, that any PDF support will require a full TeX
installation on your system to work.