onionshare/docs
Hosted Weblate b33ed673cf
Translated using Weblate (Turkish)
Currently translated at 100.0% (27 of 27 strings)

Translated using Weblate (Turkish)

Currently translated at 100.0% (9 of 9 strings)

Translated using Weblate (Turkish)

Currently translated at 100.0% (24 of 24 strings)

Translated using Weblate (Turkish)

Currently translated at 100.0% (11 of 11 strings)

Translated using Weblate (Turkish)

Currently translated at 100.0% (31 of 31 strings)

Translated using Weblate (Turkish)

Currently translated at 100.0% (28 of 28 strings)

Translated using Weblate (Turkish)

Currently translated at 100.0% (58 of 58 strings)

Translated using Weblate (Turkish)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/tr/

Translated using Weblate (Galician)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/gl/

Translated using Weblate (German)

Currently translated at 91.6% (22 of 24 strings)

Translated using Weblate (German)

Currently translated at 100.0% (31 of 31 strings)

Translated using Weblate (German)

Currently translated at 75.0% (21 of 28 strings)

Translated using Weblate (Spanish)

Currently translated at 100.0% (31 of 31 strings)

Translated using Weblate (Spanish)

Currently translated at 100.0% (9 of 9 strings)

Translated using Weblate (Lithuanian)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/lt/

Translated using Weblate (Ukrainian)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/uk/

Translated using Weblate (Norwegian Bokmål)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/nb_NO/

Translated using Weblate (German)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/de/

Translated using Weblate (Ukrainian)

Currently translated at 100.0% (28 of 28 strings)

Translated using Weblate (Ukrainian)

Currently translated at 100.0% (58 of 58 strings)

Translated using Weblate (Ukrainian)

Currently translated at 100.0% (24 of 24 strings)

Translated using Weblate (Ukrainian)

Currently translated at 100.0% (11 of 11 strings)

Translated using Weblate (Ukrainian)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/uk/

Translated using Weblate (Chinese (Simplified))
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/zh_Hans/

Translated using Weblate (Ukrainian)

Currently translated at 75.8% (44 of 58 strings)

Translated using Weblate (Ukrainian)

Currently translated at 100.0% (9 of 9 strings)

Translated using Weblate (Ukrainian)

Currently translated at 100.0% (31 of 31 strings)

Translated using Weblate (Ukrainian)

Currently translated at 82.1% (23 of 28 strings)

Translated using Weblate (Ukrainian)

Currently translated at 100.0% (27 of 27 strings)

Translated using Weblate (Ukrainian)

Currently translated at 91.6% (22 of 24 strings)

Translated using Weblate (Ukrainian)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/uk/

Co-authored-by: Allan Nordhøy <epost@anotheragency.no>
Co-authored-by: Eric <spice2wolf@gmail.com>
Co-authored-by: Gediminas Murauskas <muziejusinfo@gmail.com>
Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Ihor Hordiichuk <igor_ck@outlook.com>
Co-authored-by: Oğuz Ersen <oguzersen@protonmail.com>
Co-authored-by: Xosé M <xosem@disroot.org>
Co-authored-by: Zuhualime Akoochimoya <zakooch@protonmail.ch>
Co-authored-by: nautilusx <translate@disroot.org>
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/tr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/uk/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-develop/tr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-develop/uk/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/tr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/uk/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/es/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/tr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/uk/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/tr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/uk/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-security/tr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-security/uk/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-tor/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-tor/es/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-tor/tr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-tor/uk/
Translation: OnionShare/Doc - Advanced
Translation: OnionShare/Doc - Develop
Translation: OnionShare/Doc - Features
Translation: OnionShare/Doc - Help
Translation: OnionShare/Doc - Install
Translation: OnionShare/Doc - Security
Translation: OnionShare/Doc - Tor
2021-09-14 14:36:10 +02:00
..
gettext Build docs 2021-09-10 12:35:44 -07:00
source Translated using Weblate (Turkish) 2021-09-14 14:36:10 +02:00
build.sh Rebuild docs translations 2021-05-20 11:39:45 -04:00
check-weblate.py Fix check-weblate.py to accurately describe the levels of translations 2021-05-10 18:19:20 -07:00
make.bat Start adding documentation into the source tree 2020-08-23 22:52:43 -04:00
Makefile Start adding documentation into the source tree 2020-08-23 22:52:43 -04:00
poetry.lock Write script that uses the weblate API to help determine which languages are ready for a release 2021-05-10 18:05:41 -07:00
pyproject.toml Write script that uses the weblate API to help determine which languages are ready for a release 2021-05-10 18:05:41 -07:00
README.md Fix check-weblate.py to accurately describe the levels of translations 2021-05-10 18:19:20 -07:00

OnionShare Documentation

All these commands must be run from the docs folder.

You must have the python dependencies installed to build the docs:

poetry install

To build HTML docs:

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:

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:

# 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

Discoving which translations are >90% complete

Each OnionShare release should only include a language if >90% of the strings have been translated into it. The script check-weblate.py script can be used to make a few hundreds weblate API requests to determine this for you automatically. It requires using your weblate API key, which you can find in your user profile.

$ poetry run ./check-weblate.py $WEBLATE_API_KEY
GET https://hosted.weblate.org/api/projects/onionshare/languages/
GET https://hosted.weblate.org/api/translations/onionshare/translations/hr/
GET https://hosted.weblate.org/api/translations/onionshare/translations/eo/
GET https://hosted.weblate.org/api/translations/onionshare/translations/ja/
<...snip...>
GET https://hosted.weblate.org/api/translations/onionshare/doc-tor/wo/ | error 404
GET https://hosted.weblate.org/api/translations/onionshare/doc-tor/ar/
GET https://hosted.weblate.org/api/translations/onionshare/doc-tor/it/

App translations >= 100%
=======================
English (en), 100.0%

App translations >= 90%
=======================
Arabic (ar), 95.0%
Bengali (bn), 95.0%
Catalan (ca), 93.5%
Chinese (Simplified) (zh_Hans), 98.0%
Chinese (Traditional) (zh_Hant), 95.0%
Croatian (hr), 95.0%
Danish (da), 94.5%
Dutch (nl), 92.6%
French (fr), 98.0%
Galician (gl), 97.5%
German (de), 95.0%
Greek (el), 98.0%
Icelandic (is), 98.0%
Indonesian (id), 98.0%
Italian (it), 94.5%
Japanese (ja), 94.5%
Kurdish (Central) (ckb), 94.5%
Norwegian Bokmål (nb_NO), 98.0%
Polish (pl), 95.0%
Portuguese (Brazil) (pt_BR), 95.0%
Portuguese (Portugal) (pt_PT), 92.6%
Russian (ru), 95.0%
Serbian (latin) (sr_Latn), 95.0%
Slovak (sk), 94.5%
Spanish (es), 98.0%
Swedish (sv), 94.5%
Turkish (tr), 98.0%
Ukrainian (uk), 98.0%

App translations >= 80%
=======================
Finnish (fi), 88.1%

Docs translations >= 100%
========================
English (en), 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%
Turkish (tr), 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%
Ukrainian (uk), 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%

Docs translations >= 90%
========================


Docs translations >= 80%
========================
German (de), 90.6%, 100.0%, 82.1%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%
Greek (el), 90.6%, 100.0%, 82.1%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%
Russian (ru), 90.6%, 100.0%, 82.1%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%
Spanish (es), 90.6%, 100.0%, 82.1%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%, 100.0%