blob: fe026802c3f9ac49749a1689aa3e617d08ce9158 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
# OnionShare Documentation
All these commands must be run from the `docs` folder.
You must have the python dependencies installed to build the docs:
```sh
poetry install
```
To build HTML docs:
```sh
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:
```sh
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:
```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
```
|
