onionshare/docs
Hosted Weblate baddc6c270
Translated using Weblate (German)
Currently translated at 100.0% (11 of 11 strings)

Translated using Weblate (Swedish)

Currently translated at 100.0% (17 of 17 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 100.0% (23 of 23 strings)

Translated using Weblate (German)

Currently translated at 96.2% (26 of 27 strings)

Translated using Weblate (German)

Currently translated at 100.0% (9 of 9 strings)

Translated using Weblate (Swedish)

Currently translated at 100.0% (2 of 2 strings)

Translated using Weblate (German)

Currently translated at 100.0% (24 of 24 strings)

Translated using Weblate (Swedish)

Currently translated at 100.0% (2 of 2 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 100.0% (30 of 30 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (30 of 30 strings)

Translated using Weblate (Swedish)

Currently translated at 11.7% (2 of 17 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 100.0% (17 of 17 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 100.0% (31 of 31 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (31 of 31 strings)

Translated using Weblate (German)

Currently translated at 77.5% (45 of 58 strings)

Translated using Weblate (French)

Currently translated at 3.2% (1 of 31 strings)

Translated using Weblate (French)

Currently translated at 5.8% (1 of 17 strings)

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

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

Translated using Weblate (Portuguese (Brazil))
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/pt_BR/

Translated using Weblate (Portuguese (Brazil))

Currently translated at 73.9% (17 of 23 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (23 of 23 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 100.0% (7 of 7 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (7 of 7 strings)

Translated using Weblate (Irish)

Currently translated at 50.0% (1 of 2 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (20 of 20 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 100.0% (8 of 8 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (8 of 8 strings)

Translated using Weblate (Irish)

Currently translated at 100.0% (2 of 2 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 66.6% (20 of 30 strings)

Translated using Weblate (Polish)

Currently translated at 16.6% (5 of 30 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 88.2% (15 of 17 strings)

Translated using Weblate (Polish)

Currently translated at 100.0% (17 of 17 strings)

Translated using Weblate (Portuguese (Brazil))

Currently translated at 29.0% (9 of 31 strings)

Translated using Weblate (Polish)

Currently translated at 29.0% (9 of 31 strings)

Translated using Weblate (French)

Currently translated at 14.2% (1 of 7 strings)

Translated using Weblate (French)

Currently translated at 30.0% (6 of 20 strings)

Translated using Weblate (Spanish)

Currently translated at 79.3% (46 of 58 strings)

Translated using Weblate (Spanish)

Currently translated at 79.3% (46 of 58 strings)

Translated using Weblate (Arabic)

Currently translated at 71.4% (5 of 7 strings)

Translated using Weblate (Arabic)

Currently translated at 25.8% (8 of 31 strings)

Translated using Weblate (Spanish)

Currently translated at 75.0% (21 of 28 strings)

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

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

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

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

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

Translated using Weblate (Portuguese (Brazil))
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/pt_BR/

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

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

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

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

Translated using Weblate (Portuguese (Brazil))
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/pt_BR/

Added translation using Weblate (English (Middle))

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

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

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

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

Co-authored-by: 5IGI0 <5IGI0@protonmail.com>
Co-authored-by: Anderson Fraga <aaa_lab@naver.com>
Co-authored-by: Atrate <Atrate@protonmail.com>
Co-authored-by: ButterflyOfFire <ButterflyOfFire@protonmail.com>
Co-authored-by: Duncan Dean <duncangleeddean@gmail.com>
Co-authored-by: EdwardCage <contact@edwardcage.pro>
Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Kevin Scannell <kscanne@gmail.com>
Co-authored-by: Mauricio <s01@duck.com>
Co-authored-by: Michael Breidenbach <leahc@tutanota.com>
Co-authored-by: Rafał Godek <p3run@tutanota.com>
Co-authored-by: Raul <rgarciag@tutanota.com>
Co-authored-by: Robert Obryk <robryk@gmail.com>
Co-authored-by: Santiago Passafiume <santiagopassafiume@protonmail.com>
Co-authored-by: Shivam Soni <shivamsoni.soni3@gmail.com>
Co-authored-by: Three Deus <threedeus@protonmail.com>
Co-authored-by: carlosm2 <carlosm2@riseup.net>
Co-authored-by: register718 <register2021@outlook.de>
Co-authored-by: souovan <souovan@protonmail.com>
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/es/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/fr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/pl/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/pt_BR/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/sv/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-develop/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-develop/pl/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-develop/pt_BR/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/ar/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/es/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/fr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/pl/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/pt_BR/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/ar/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/fr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/pl/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/pt_BR/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-index/ga/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-index/sv/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/fr/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/pl/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-security/de/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-security/pl/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-security/pt_BR/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-sphinx/ga/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-sphinx/sv/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-tor/pl/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-tor/pt_BR/
Translation: OnionShare/Doc - Advanced
Translation: OnionShare/Doc - Develop
Translation: OnionShare/Doc - Features
Translation: OnionShare/Doc - Help
Translation: OnionShare/Doc - Index
Translation: OnionShare/Doc - Install
Translation: OnionShare/Doc - Security
Translation: OnionShare/Doc - Sphinx
Translation: OnionShare/Doc - Tor
2021-09-19 20:10:25 +02:00
..
gettext Build docs 2021-09-10 12:35:44 -07:00
source Translated using Weblate (German) 2021-09-19 20:10:25 +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%