Skip to content

zammad/zammad-user-documentation

Repository files navigation

Documentation Status Translation Status (pre-release)

Documentation Status Translation Status (latest)

Zammad User Documentation

Source files for Zammad’s user documentation (latest / pre-release).

Contributing

Please see the Contributing section in this manual.

Compilation

Dependencies

  • sphinx

    $ pip install sphinx sphinx-autobuild sphinx-intl sphinx_rtd_theme sphinx-tabs
    
  • gettext

    $ brew install gettext              # macOS
    $ sudo apt install gettext          # Debian / Ubuntu
    $ sudo dnf install gettext          # Fedora
    

Example for a local HTML build

make html

Building for a specific language:

$ make -e SPHINXOPTS="-D language='en'" html

Localization progress

Translation progress