Skip to content

Commit 5570480

Browse files
committed
Links to PyPI, newlines after headings, build and contribute section improvements
1 parent 9bb722e commit 5570480

2 files changed

Lines changed: 17 additions & 18 deletions

File tree

README.en.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ f'''[![build](https://github.com/python/python-docs-pl/actions/workflows/update-
2727

2828
### How do I check what needs translating?
2929

30-
Use the `potodo` package. Run it in the project's root directory, for example: `uvx potodo`.
30+
Use the [`potodo`](https://pypi.org/project/sphinx-lint/) package. Run it in the project's root directory,
31+
for example: `uvx potodo`.
3132

3233
If you are interested in the core articles, use filtering. For example:
3334

@@ -49,9 +50,7 @@ Suggested priority resources for translation can be found in [issue #50](https:/
4950
* Create an account on Transifex.
5051
* Select Polish on the project page.
5152
* After submitting your request to join the team, introduce yourself on the [Python Polska #dokumentacja Discord channel](https://discord.gg/QB3h2Sxc). This will help us approve your request sooner.
52-
* After joining the team, select the resource you want to improve or update.
53-
54-
You can find more information about using Transifex
53+
* After joining the team, select the resource you want to improve or update. You can find more information about using Transifex
5554
in [their help articles](https://help.transifex.com/en/articles/6318216-translating-with-the-web-editor) or [our guide](https://python-docs-transifex-automation.readthedocs.io/new-translators.html).
5655

5756
### How do I check my changes locally?
@@ -73,7 +72,7 @@ python-newest.library--turtle [pl] - Done
7372
[##############################] (1 / 1)
7473
```
7574

76-
Run `sphinx-lint` to check your changes, for example:
75+
Run [`sphinx-lint`](https://pypi.org/project/sphinx-lint/) to check your changes, for example:
7776

7877
```
7978
$ uvx sphinx-lint library/turtle.po
@@ -88,12 +87,7 @@ The documentation at https://docs.python.org/pl/ is updated around once daily.
8887

8988
### How do I build the documentation?
9089

91-
You need a checkout of the CPython repository to build the documentation.
92-
93-
Create a symbolic link (Unix) or a copy (Windows) of the `python-docs-pl` project in the CPython repository's
94-
`Doc/locales/pl` directory, named `LC_MESSAGES`.
95-
96-
Then run `make -C Doc SPHINXOPTS="-D language=pl" html` in the CPython repository to build the documentation.
90+
[See devguide's instructions.](https://devguide.python.org/documentation/translations/translating/#how-do-i-build-a-docs-translation)
9791

9892
### Communication channels
9993

@@ -119,16 +113,19 @@ In return, it will be visible that you are the translator of the part you transl
119113
You signify your acceptance of this agreement by submitting your work for inclusion in the documentation.
120114

121115
### Repository updates
116+
122117
* `./manage_translation.py recreate_tx_config`
123118
* `./manage_translation.py fetch`
124119
* `cog -rP README.en.md`
125120

126121
### Useful materials
122+
127123
* [Python Developer's Guide: Translating](https://devguide.python.org/documentation/translations/translating/)
128124
* [Python docs Transifex: Documentation](https://python-docs-transifex-automation.readthedocs.io/)
129125
* [Site Statistics](https://analytics.python.org/docs.python.org?f=contains,page,/pl/)
130126

131127
### Similar projects
128+
132129
* [Projects of the Python Packaging Authority](https://hosted.weblate.org/projects/pypa/-/pl/)
133130
* [Scientific Python Translations](https://scientific-python-translations.github.io/)
134131
* [micro:bit translation programme](https://microbit.org/translate/)

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ f'''[![build](https://github.com/python/python-docs-pl/actions/workflows/update-
2727

2828
### Jak sprawdzić, co jest do przetłumaczenia?
2929

30-
Służy do tego paczka `potodo`. Wywołaj ją w głównym katalogu projektu, np. `uvx potodo`.
30+
Służy do tego paczka [`potodo`](https://pypi.org/project/potodo/). Wywołaj ją w głównym katalogu projektu,
31+
na przykład `uvx potodo`.
3132

3233
Jeżeli interesują cię podstawowe artykuły, użyj filtrowania. Przykład:
3334

@@ -50,9 +51,7 @@ projektu [dokumentacji Pythona](https://explore.transifex.com/python-doc/python-
5051
* Utwórz konto Transifex.
5152
* Na stronie projektu wybierz język polski.
5253
* Po wysłaniu zgłoszenia do zespołu przedstaw się na kanale [Discord Python Polska #dokumentacja](https://discord.gg/QB3h2Sxc). Pozwoli to szybciej potwierdzić Twoje zgłoszenie.
53-
* Po dołączeniu do zespołu wybierz zasób, który chcesz poprawić/zaktualizować.
54-
55-
Więcej informacji o używaniu Transifeksa znajdziesz w
54+
* Po dołączeniu do zespołu wybierz zasób, który chcesz poprawić/zaktualizować. Więcej informacji o używaniu Transifeksa znajdziesz w
5655
[jego artykułach pomocy](https://help.transifex.com/en/articles/6318216-translating-with-the-web-editor) lub [w naszym przewodniku](https://python-docs-transifex-automation.readthedocs.io/new-translators.html).
5756

5857
### Jak lokalnie sprawdzić poprawność moich zmian?
@@ -74,7 +73,7 @@ python-newest.library--turtle [pl] - Done
7473
[##############################] (1 / 1)
7574
```
7675

77-
Uruchom `sphinx-lint`, aby sprawdzić poprawność zmian, np.:
76+
Uruchom [`sphinx-lint`](https://pypi.org/project/sphinx-lint/), aby sprawdzić poprawność zmian, na przykład:
7877

7978
```
8079
$ uvx sphinx-lint library/turtle.po
@@ -91,8 +90,8 @@ Dokumentacja na https://docs.python.org/pl/ aktualizowana jest około raz dzienn
9190

9291
Aby zbudować dokumentację potrzebujesz mieć kopię repozytorium CPythona.
9392

94-
Zrób link symboliczny (Unix) lub kopię (Windows) projektu `python-docs-pl` w katalogu `Doc/locales/pl` repozytorium
95-
CPython, o nazwie `LC_MESSAGES`.
93+
Zrób link symboliczny (Unix) lub kopię (Windows) zawartości projektu `python-docs-pl` w katalogu
94+
`Doc/locales/pl/LC_MESSAGES` w repozytorium CPython.
9695

9796
Następnie uruchom `make -C Doc SPHINXOPTS="-D language=pl" html` w projekcie CPython, aby zbudować dokumentację.
9897

@@ -120,16 +119,19 @@ W zamian będzie widoczne, że jesteś tłumaczem(-ką) części, którą przet
120119
Wyrażasz akceptację tej umowy, przesyłając swoją pracę do włączenia do dokumentacji.
121120

122121
### Aktualizacje w repozytorium
122+
123123
* `./manage_translation.py recreate_tx_config`
124124
* `./manage_translation.py fetch`
125125
* `cog -rP README.md`
126126

127127
### Przydatne materiały
128+
128129
* [Python Developer's Guide: Translating](https://devguide.python.org/documentation/translations/translating/)
129130
* [Python docs Transifex: Documentation](https://python-docs-transifex-automation.readthedocs.io/)
130131
* [statystyki oglądalności](https://analytics.python.org/docs.python.org?f=contains,page,/pl/)
131132

132133
### Podobne projekty
134+
133135
* [projekty Python Packaging Authority](https://hosted.weblate.org/projects/pypa/-/pl/)
134136
* [Scientific Python Translations](https://scientific-python-translations.github.io/)
135137
* [micro:bit translation programme](https://microbit.org/translate/)

0 commit comments

Comments
 (0)