mirror of https://github.com/onionshare/onionshare.git synced 2024-10-01 01:35:40 -04:00

History

Allan Nordhøy 6b4d5a0fa1 Features documentation reworked		2020-09-23 09:42:24 +00:00
..
gettext	Migrate docs dependencies from requirements.txt to poetry	2020-09-20 20:30:54 -07:00
source	Features documentation reworked	2020-09-23 09:42:24 +00:00
build.sh	alphabetical order makes easier to check languages	2020-09-18 13:29:10 +00: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
poetry.lock	Migrate docs dependencies from requirements.txt to poetry	2020-09-20 20:30:54 -07:00
pyproject.toml	Migrate docs dependencies from requirements.txt to poetry	2020-09-20 20:30:54 -07:00
README.md	Migrate docs dependencies from requirements.txt to poetry	2020-09-20 20:30:54 -07:00

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