.. _doc-setup:

Setup the Manual
================

Installing Dependencies
-----------------------

Linux
^^^^^

Debian/Ubuntu:

.. code-block:: console

   sudo apt-get install python3 python3-pip


macOS
^^^^^


Windows
^^^^^^^

Downloading the Repository
--------------------------

First, create a project folder on your hard drive. Open a terminal in that folder and checkout the Scribus Manual repository using:

.. code-block:: console

   git https://codeberg.org/Scribus/scribus-manual.git
   cd ./scribus-manual

.. note::

   Our project folder is: ``scribus-manual``.


Setting up the Build Environment
--------------------------------

Set up Environment Variable (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

It is recommended to setup and activate a virtual Python environment where dependencies will be installed:

.. code-block:: console

   python3 -m venv .venv
   source .venv/bin/activate

Repeat the ``source .venv/bin/activate`` command to re-activate the virtual environment, whenever you open a new terminal to build the documentation.


Install Requirements
^^^^^^^^^^^^^^^^^^^^

Open terminal in Scribus documentation folder and install all requirements by run:

.. code-block:: console

   pip3 install -r requirements.txt


.. note::

    To keep all requirements up to da you can run:

    .. code-block:: console

       pip3 install -r requirements.txt --upgrade

Update Requirements
^^^^^^^^^^^^^^^^^^^

If you install new python packages in your local installation you can add them to the requirements.txt by run:

.. code-block:: console

   pip freeze > requirements.txt