ww102111 / user-docs

User Manual for Effektif

Effektif User Manual

See the admin guide instructions for more information.

Set-up

The following instructions assume Python is already installed.

0. (optional) You might want to set up a virtualenv.

1. Install Python module dependencies - PIP, termcolor and tabulate:

    sudo easy_install pip
   

2. Set language environment variables:

    export LC_ALL=en_US.UTF-8
    export LANG=en_US.UTF-8
   

3. Install all requirements:

    pip install -r requirements
   

Editing the documentation

The documentation contents are in reStructuredText format. The standard language for writing is english.

Building the documentation

In general you can easily build the docs from the root directory by running

./build.sh <de|en>

This will output the docs as HTML into docs/_build. If you want to build to something other than HTML, you can proceed as follows:

cd docs
make html

To build the documentation for a specific language you need to use the language specifc conf.yp files. Those are located in the respective lang_code subdirectories, i.e. de or en.

Updating translations

The files in docs/_locale are used for translations. Update these with:

./i18n.sh