Move docs back to root, move onionshare_gui into briefcase app, and make modifications so briefcase app will work

This commit is contained in:
Micah Lee 2020-10-13 17:28:54 -07:00
parent f4abcf1be9
commit b42f92d714
No known key found for this signature in database
GPG key ID: 403C2657CD994F73
490 changed files with 226 additions and 14886 deletions

38
docs/README.md Normal file
View file

@ -0,0 +1,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
```