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:
|
|
|
|
|
|
|
|
|
|
```sh
|
2020-08-26 23:14:12 -04:00
|
|
|
pip3 install --user -r requirements.txt
|
2020-08-24 19:30:21 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To build HTML docs:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
make html
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Then open `docs/build/html/index.html` in a browser to see it.
|
|
|
|
|
|
|
|
|
|
To prepare translations:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
# 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
|
|
|
|
|
```
|
