diff options
author | Micah Lee <micah@micahflee.com> | 2020-08-24 19:30:21 -0400 |
---|---|---|
committer | Micah Lee <micah@micahflee.com> | 2020-08-24 19:30:21 -0400 |
commit | b3b09a6f2caa5c940184f6f127cfc19513ff09f0 (patch) | |
tree | ad05b16446e5105ee05954cfa9536d7768e09eea /docs/README.md | |
parent | 50dbe20270841ca24ffad4d8e033f1dc58cfd308 (diff) | |
download | onionshare-b3b09a6f2caa5c940184f6f127cfc19513ff09f0.tar.gz onionshare-b3b09a6f2caa5c940184f6f127cfc19513ff09f0.zip |
Switch to sphinx-rtd-theme and use sphinx-intl
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..3811f1f7 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,30 @@ +# OnionShare Documentation + +All these commands must be run from the `docs` folder. + +You must have the python dependencies installed to build the docs: + +```sh +pip3 install --user requirements.txt +``` + +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 +``` |