onionshare/docs
2020-09-17 12:32:20 +00:00
..
gettext Update docs for just English and Spanish (for now) 2020-09-14 14:44:40 -07:00
source Merge remote-tracking branch 'weblate/develop' into develop 2020-09-17 12:32:20 +00:00
build.sh Update docs for just English and Spanish (for now) 2020-09-14 14:44:40 -07:00
make.bat Start adding documentation into the source tree 2020-08-23 22:52:43 -04:00
Makefile Start adding documentation into the source tree 2020-08-23 22:52:43 -04:00
README.md Add the same locales that OnionShare is translated into 2020-08-26 21:13:53 -07:00
requirements.txt Switch to sphinx-rtd-theme and use sphinx-intl 2020-08-24 19:30:21 -04:00

OnionShare Documentation

All these commands must be run from the docs folder.

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

pip3 install --user -r requirements.txt

To build HTML docs:

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:

./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