diff options
| author | Micah Lee <micah@micahflee.com> | 2020-10-12 22:40:55 -0700 |
|---|---|---|
| committer | Micah Lee <micah@micahflee.com> | 2020-10-12 22:40:55 -0700 |
| commit | f4abcf1be9122a28005dc3e0949bf5952192e982 (patch) | |
| tree | 0c6fdb71401ac294403fe87730ef6a73b0d7498a /docs/README.md | |
| parent | b81a55f546ffaf00586e43cdc279b967da096e4f (diff) | |
| download | onionshare-f4abcf1be9122a28005dc3e0949bf5952192e982.tar.gz onionshare-f4abcf1be9122a28005dc3e0949bf5952192e982.zip | |
Add onionshare CLI to cli folder, move GUI to desktop folder, and start refactoring it to work with briefcase
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index fe026802..00000000 --- a/docs/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# 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 -``` |