Skip to content

Commit f9d98f8

Browse files
BHUVANSH855BHUVANSH855
committed
Add project infrastructure and complete controlflow translation
1 parent 0e82478 commit f9d98f8

7 files changed

Lines changed: 1873 additions & 13 deletions

File tree

‎.github/workflows/validate.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Validate PO Files
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
validate:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v4
14+
15+
- name: Install gettext
16+
run: |
17+
sudo apt-get update
18+
sudo apt-get install -y gettext
19+
20+
- name: Validate PO files
21+
run: |
22+
find locales -name "*.po" -exec msgfmt --check {} \;

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Compiled gettext files
2+
*.mo

‎CONTRIBUTING.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing to Python Docs Punjabi (pa-IN)
2+
3+
Thank you for contributing to the Punjabi translation of Python documentation.
4+
5+
## Workflow
6+
7+
1. Fork the repository.
8+
2. Create a feature branch.
9+
3. Translate or review `.po` files.
10+
4. Validate before committing.
11+
12+
## Validation
13+
14+
Run:
15+
16+
```bash
17+
msgfmt --check file.po

‎GLOSSARY.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Punjabi (pa-IN) Python Docs Glossary
2+
3+
| English | Punjabi |
4+
|----------|----------|
5+
| function | ਫੰਕਸ਼ਨ |
6+
| list | ਸੂਚੀ |
7+
| dictionary | ਡਿਕਸ਼ਨਰੀ |
8+
| tuple | ਟਪਲ |
9+
| set | ਸੈੱਟ |
10+
| string | ਸਤਰ |
11+
| integer | ਪੂਰਨ ਅੰਕ |
12+
| float | ਫਲੋਟ |
13+
| boolean | ਬੁਲੀਅਨ |
14+
| variable | ਚਲ |
15+
| exception | ਅਪਵਾਦ |
16+
| module | ਮੌਡਿਊਲ |
17+
| package | ਪੈਕੇਜ |
18+
| class | ਕਲਾਸ |
19+
| object | ਵਸਤੂ |
20+
| method | ਵਿਧੀ |
21+
| argument | ਆਰਗੂਮੈਂਟ |
22+
| parameter | ਪੈਰਾਮੀਟਰ |
23+
| output | ਆਉਟਪੁੱਟ |
24+
| input | ਇਨਪੁੱਟ |
25+
| error | ਗਲਤੀ |
26+
| loop | ਲੂਪ |
27+
| interpreter | ਦੁਭਾਸ਼ੀਆ |
28+
| namespace | ਨੇਮਸਪੇਸ |
29+
| scope | ਦਾਇਰਾ |

‎README.rst‎

Lines changed: 67 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,76 @@
1-
Translation of the Python Documentation — pa-IN
2-
===============================================
1+
# Translation of the Python Documentation — pa-IN
32

43
Punjabi (India) translation of the Python documentation.
54

6-
Status
7-
------
5+
This project aims to translate Python's official documentation into
6+
Punjabi (Gurmukhi) and make Python learning resources more accessible
7+
to Punjabi-speaking developers, students, and educators.
88

9-
Work in progress.
9+
## Status
1010

11-
Goals
12-
-----
11+
🚧 Work in Progress
1312

14-
- Translate Python documentation into Punjabi (Gurmukhi)
15-
- Maintain terminology consistency
16-
- Follow Python documentation translation guidelines
17-
- Build a contributor community around Punjabi translations
13+
## Current Progress
1814

19-
License
20-
-------
15+
Tutorial Section
16+
17+
* introduction.po — Complete
18+
* controlflow.po — Complete
19+
20+
Infrastructure
21+
22+
* STYLE_GUIDE.md — Complete
23+
* GLOSSARY.md — Complete
24+
* CONTRIBUTING.md — Complete
25+
* GitHub Actions validation workflow — Complete
26+
27+
## Goals
28+
29+
* Translate Python documentation into Punjabi (Gurmukhi)
30+
* Maintain terminology consistency through a shared glossary
31+
* Follow Python documentation translation guidelines
32+
* Ensure translation quality through automated validation
33+
* Build a contributor community around Punjabi translations
34+
* Contribute to the Python documentation translation ecosystem
35+
36+
## Repository Structure
37+
38+
::
39+
40+
```
41+
python-docs-pa-in/
42+
├── README.rst
43+
├── STYLE_GUIDE.md
44+
├── GLOSSARY.md
45+
├── CONTRIBUTING.md
46+
├── .github/workflows/
47+
└── locales/pa-IN/LC_MESSAGES/
48+
```
49+
50+
## Translation Workflow
51+
52+
1. Translate .po files.
53+
54+
2. Validate using::
55+
56+
```
57+
msgfmt --check file.po
58+
```
59+
60+
3. Review terminology against `GLOSSARY.md`.
61+
62+
4. Ensure markup and code blocks remain intact.
63+
64+
5. Commit and submit changes.
65+
66+
## References
67+
68+
* Python Documentation Translation Guide:
69+
https://devguide.python.org/documentation/translations/
70+
71+
* Python Documentation Project:
72+
https://docs.python.org/
73+
74+
## License
2175

2276
Documentation translations are contributed under the CC0 license.

‎STYLE_GUIDE.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Punjabi (pa-IN) Python Docs Style Guide
2+
3+
## Never Translate
4+
5+
### Python Keywords
6+
7+
if
8+
else
9+
elif
10+
for
11+
while
12+
class
13+
def
14+
return
15+
import
16+
17+
### Variable Names
18+
19+
x
20+
y
21+
count
22+
user_name
23+
my_list
24+
25+
### RST Roles
26+
27+
:func:`print`
28+
:class:`list`
29+
:mod:`os`
30+
:ref:`section`
31+
32+
### URLs
33+
34+
Leave all URLs unchanged.
35+
36+
---
37+
38+
## Code Blocks
39+
40+
Translate:
41+
42+
- Comments
43+
- Explanatory text
44+
45+
Do not translate:
46+
47+
- Python keywords
48+
- Variable names
49+
- Function names
50+
- Class names
51+
- Module names
52+
53+
---
54+
55+
## Tone
56+
57+
- Use formal Punjabi
58+
- Follow GLOSSARY.md terminology
59+
- Keep translations consistent across files

0 commit comments

Comments
 (0)