Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/update-lint-and-build.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
name: Translation and Linting Workflow

on:
schedule:
- cron: '*/30 * * * *'
push:
branches:
- '*'
workflow_dispatch:

jobs:
update-translation:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -32,11 +35,17 @@ jobs:
- run: ./manage_translation.py fetch
env:
TX_TOKEN: ${{ secrets.TX_TOKEN }}
# Process README.md
- run: python -Werror -m cogapp -rP README.md
env:
TX_TOKEN: ${{ secrets.TX_TOKEN }}
# Process README.en.md
- run: python -Werror -m cogapp -rP README.en.md
env:
TX_TOKEN: ${{ secrets.TX_TOKEN }}
- run: git config --local user.email github-actions@github.com
- run: git config --local user.name "GitHub Action's update-translation job"
# Check for changes in README.md
- run: >
! git diff -I'^"POT-Creation-Date: ' -I'^"Language-Team: ' -I'^# Copyright (C) 2001-' --exit-code && echo "SIGNIFICANT_CHANGES=1" >> $GITHUB_ENV || exit 0
- run: >
Expand All @@ -61,6 +70,7 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
event-type: translation-updated

lint:
runs-on: ubuntu-latest
strategy:
Expand All @@ -77,6 +87,7 @@ jobs:
with:
ref: ${{ matrix.version }}
- run: sphinx-lint

build-translation:
runs-on: ubuntu-latest
strategy:
Expand Down Expand Up @@ -106,6 +117,7 @@ jobs:
with:
name: build-${{ matrix.version }}-${{ matrix.format }}
path: Doc/build/${{ matrix.format }}

output-pdf:
runs-on: ubuntu-latest
strategy:
Expand Down
80 changes: 80 additions & 0 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
Polish Translation of Python Documentation
========================================
<!-- [[[cog
from manage_translation import get_resource_language_stats, progress_from_resources, language_switcher, get_number_of_translators

stats = get_resource_language_stats()
switcher = progress_from_resources(filter(language_switcher, stats))
total = progress_from_resources(stats)
translators = get_number_of_translators()

print(
f'''![build](https://github.com/python/python-docs-pl/workflows/.github/workflows/update-lint-and-build.yml/badge.svg)
![{switcher:.2f}% Language Switcher](https://img.shields.io/badge/language_switcher-{switcher:.2f}%25-0.svg)
![Total Translation of Documentation](https://img.shields.io/badge/Total-{total:.2f}%25-0.svg)
![{translators} Translators](https://img.shields.io/badge/Translators-{translators}-0.svg)''')
]]] -->
![build](https://github.com/python/python-docs-pl/workflows/.github/workflows/update-lint-and-build.yml/badge.svg)
![70.16% Language Switcher](https://img.shields.io/badge/language_switcher-70.16%25-0.svg)
![Total Translation of Documentation](https://img.shields.io/badge/Total-3.75%25-0.svg)
![24 Translators](https://img.shields.io/badge/Translators-24-0.svg)
<!-- [[[end]]] -->

*Przeczytaj to w innym języku: [Polski](README.md)*

If you find a mistake or have a suggestion,
[let us know](https://github.com/python/python-docs-pl/issues) or fix it yourself:

* Go to the website of the project [Python Documentation](https://explore.transifex.com/python-doc/python-newest/).
* Click the button "Join this project", to join the Project.
* Create an account on Transifex.
* On the project website pick the language Polish.
* After joining the Project, pick the category you want to fix/translate.

You can find more information about using Transifex
[in their help guide.](https://help.transifex.com/en/articles/6318216-translating-with-the-web-editor).

**Translation Progress**

![translation progress till Polish is added to the language switcher](language-switcher-progress.svg)

The Polish language will appear in the language switcher in docs.python.org,
[when these categories will be fully translated](https://www.python.org/dev/peps/pep-0545/#add-translation-to-the-language-switcher):
* `bugs`,
* Everything in the `tutorial` section,
* `library/functions`.

**How to see the newest build of the documentation?**

Download the latest build from the list of artefacts in the latest GitHub Action (Actions Tab).
Translations are pulled from Transifex around every half hour.
The documentation at https://docs.python.org/pl/ is updated around once daily.

**Communication Channels**

* [Discord Python Polska #dokumentacja](https://discord.gg/QB3h2Sxc)
* [Python Documentation Community](https://docs-community.readthedocs.io/en/latest/)
* [Python Translations Working Group](https://mail.python.org/mailman3/lists/translation.python.org/)
* [Python Documentation Special Interest Group](https://www.python.org/community/sigs/current/doc-sig/)

**License**

By inviting you to work on a project on the Transifex platform, we offer a contract for
donating your translations to the Python Software Foundation
[under the CC0 license](https://creativecommons.org/publicdomain/zero/1.0/deed.pl).
In return, it will be visible that you are the translator of the part you translated.
You signify your acceptance of this agreement by submitting your work for inclusion in the documentation.

**Updating Translations**
* `./manage_translation.py recreate_tx_config`
* `./manage_translation.py fetch`
* `cog -rP README.md`

**Useful Materials**
* [Site Statistics](https://plausible.io/docs.python.org/?filters=%28%28contains,page,%28/pl/%29%29%29)
* [Python Developer's Guide: Documentation](https://devguide.python.org/documentation/)

**Similar Translation Projects**
* [Projects of the Python Packaging Authority](https://hosted.weblate.org/projects/pypa/-/pl/)
* [Scientific Python Translations](https://scientific-python-translations.github.io/)
* [Localizing Django](https://docs.djangoproject.com/en/dev/internals/contributing/localizing/)
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ f'''![build](https://github.com/python/python-docs-pl/workflows/.github/workflow
![24 tłumaczy](https://img.shields.io/badge/tłumaczy-24-0.svg)
<!-- [[[end]]] -->

*Read this in another language: [English](README.en.md)*

Jeśli znalazłeś(-aś) błąd lub masz sugestię,
[dodaj zgłoszenie](https://github.com/python/python-docs-pl/issues) w tym projekcie lub
napraw go sam(a):
Expand Down