.. _doc-build:

Building the Manual
===================

Compile the Manual as HTML
--------------------------

Open the terminal in documentation foler (where ``makefile`` is included) and run:

.. code-block:: console

   make html

All compiled html files are located in `build/html`.


Generate Localisation Files (\*pot)
-----------------------------------

To create ``*.pot`` files you have to run:

.. code-block:: console

   cd ./source
   sphinx-build -b gettext . _build/gettext

It will output a separate ``*.pot`` file for each ``*.rst`` files in ``./scribus-manual/source/_build/gettext/``.


Create Translation Files from Template (\*.po)
----------------------------------------------

To generate new translation folders with local copies of all ``*.pot`` file run the command below.
Add an ``-l`` parameter followed by the language code, e.g ``-l de_DE`` to create new localisation folders.

.. code-block:: console

   cd ./source
   sphinx-intl update -p _build/gettext -l de_DE -l fr_FR -l es_ES

Localisation files output in: ``./scribus-manual/source/locale/``.