onionshare/docs
Allan Nordhøy 133429cb40
Ending dot
2020-11-18 09:01:38 +00:00
..
gettext Update docs translations 2020-11-15 14:44:58 -08:00
source Ending dot 2020-11-18 09:01:38 +00:00
build.sh Update docs translations 2020-11-15 14:44:58 -08: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 Update poetry deps for docs 2020-11-15 13:10:47 -08:00
pyproject.toml Version bump to 2.3.dev2, and update Linux installation in docs 2020-11-08 20:45:54 -08:00
README.md Migrate docs dependencies from requirements.txt to poetry 2020-09-20 20:30:54 -07:00

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