Roadiz documentation
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_static
developer
extension
locale/fr/LC_MESSAGES
user
.gitignore
.gitmodules
.readthedocs.yml
Makefile
README.md
conf.py
index.rst
stable-req.txt

README.md

Roadiz documentation

Install locally

# Make sure python3 is setup
# On MacOS, use brew
# brew install python3

pip3 install sphinx  --user
pip3 install sphinx-intl --user
pip3 install recommonmark --user
pip3 install pygments-markdown-lexer --user

Prepare translations

make gettext
sphinx-intl update -p _build/locale -l fr

Then translate each .po file with PoEdit. And build your documentation with:

make -e SPHINXOPTS="-D language='fr'" html

Export in PDF

make latex
cd _build/latex
pdflatex -interaction=batchmode Roadiz