onionshare/docs
..
gettext Move docs back to root, move onionshare_gui into briefcase app, and make modifications so briefcase app will work 2020-10-13 17:28:54 -07:00
source
build.sh
make.bat
Makefile
poetry.lock
pyproject.toml
README.md

OnionShare Documentation

All these commands must be run from the docs folder.

You must have the python dependencies installed to build the docs:

poetry install

To build HTML docs:

poetry run make html

Then open docs/build/html/index.html in a browser to see it.

To update all of the translations and build all the html, run:

poetry run ./build.sh

You will end up with the documentation in all supported locales in docs/localized_html.

Here's how preparing translations works:

# Generate .po files in build/gettext 
make gettext

# Create a new blank German locale in source/locale, based on .po files
sphinx-intl update -p build/gettext -l de

# Build German translated document
make -e SPHINXOPTS="-D language='de'" html