Skip to content

Commit 440fdf3

Browse files
committed
first commit
0 parents  commit 440fdf3

511 files changed

Lines changed: 305014 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
*.mo
2+
*.po.bak
3+
*.pot
4+
.DS_Store
5+
.idea/
6+
.pospell/
7+
.potodo/
8+
.venv/
9+
.vs/
10+
.vscode/
11+
locales/
12+
venv/
13+
__pycache__/

Makefile

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Makefile for fa Python Documentation
2+
#
3+
# Here is what you can do:
4+
#
5+
# - make # Automatically build an HTML local version
6+
# - make todo # To list remaining tasks and show current progression
7+
# - make verifs # To check for correctness: wrapping, spelling
8+
# - make wrap # To rewrap modified files
9+
# - make spell # To check for spelling
10+
# - make clean # To remove build artifacts
11+
# - make fuzzy # To find fuzzy strings
12+
#
13+
# Modes are: autobuild-stable, autobuild-dev, and autobuild-html
14+
15+
# Configuration
16+
17+
# The CPYTHON_CURRENT_COMMIT is the commit, in the cpython repository,
18+
# from which we generated our po files. We use it here so when we
19+
# test build, we're building with the .rst files that generated our
20+
# .po files.
21+
22+
CPYTHON_CURRENT_COMMIT := d26c2fe7a2833606b3fb8d9789149d8696978d86
23+
LANGUAGE := fa
24+
BRANCH := 3.13
25+
26+
EXCLUDED := \
27+
whatsnew/2.?.po \
28+
whatsnew/3.[0-10].po
29+
30+
# Internal variables
31+
32+
UPSTREAM := https://github.com/python/cpython
33+
34+
PYTHON := $(shell which python3)
35+
MODE := html
36+
POSPELL_TMP_DIR := .pospell/
37+
JOBS := auto
38+
ADDITIONAL_ARGS := --keep-going --color
39+
SPHINXERRORHANDLING = -W
40+
41+
# Detect OS
42+
43+
ifeq '$(findstring ;,$(PATH))' ';'
44+
detected_OS := Windows
45+
else
46+
detected_OS := $(shell uname 2>/dev/null || echo Unknown)
47+
detected_OS := $(patsubst CYGWIN%,Cygwin,$(detected_OS))
48+
detected_OS := $(patsubst MSYS%,MSYS,$(detected_OS))
49+
detected_OS := $(patsubst MINGW%,MSYS,$(detected_OS))
50+
endif
51+
52+
ifeq ($(detected_OS),Darwin) # Mac OS X
53+
CP_CMD := gcp # accessible with `brew install coreutils` or `brew upgrade coreutils`
54+
else
55+
CP_CMD := cp
56+
endif
57+
58+
.PHONY: all
59+
all: ensure_prerequisites
60+
git -C venv/cpython checkout $(CPYTHON_CURRENT_COMMIT) || (git -C venv/cpython fetch && git -C venv/cpython checkout $(CPYTHON_CURRENT_COMMIT))
61+
mkdir -p locales/$(LANGUAGE)/LC_MESSAGES/
62+
$(CP_CMD) -u --parents *.po */*.po locales/$(LANGUAGE)/LC_MESSAGES/
63+
$(MAKE) -C venv/cpython/Doc/ \
64+
JOBS='$(JOBS)' \
65+
SPHINXOPTS='-D locale_dirs=$(abspath locales) \
66+
-D language=$(LANGUAGE) \
67+
-D gettext_compact=0 \
68+
-D latex_engine=xelatex \
69+
-D latex_elements.inputenc= \
70+
-D latex_elements.fontenc= \
71+
$(ADDITIONAL_ARGS)' \
72+
SPHINXERRORHANDLING=$(SPHINXERRORHANDLING) \
73+
$(MODE)
74+
@echo "Build success, open file://$(abspath venv/cpython/)/Doc/build/html/index.html or run 'make htmlview' to see them."
75+
76+
77+
# We clone cpython/ inside venv/ because venv/ is the only directory
78+
# excluded by cpython' Sphinx configuration.
79+
venv/cpython/.git/HEAD:
80+
git clone https://github.com/python/cpython venv/cpython
81+
82+
83+
.PHONY: ensure_prerequisites
84+
ensure_prerequisites: venv/cpython/.git/HEAD
85+
@if ! (blurb help >/dev/null 2>&1 && sphinx-build --version >/dev/null 2>&1); then \
86+
git -C venv/cpython/ checkout $(BRANCH); \
87+
echo "You're missing dependencies please install:"; \
88+
echo ""; \
89+
echo " python -m pip install -r venv/cpython/Doc/requirements.txt"; \
90+
exit 1; \
91+
fi
92+
93+
.PHONY: htmlview
94+
htmlview: MODE=htmlview
95+
htmlview: all
96+
97+
.PHONY: todo
98+
todo: ensure_prerequisites
99+
potodo --exclude venv .venv $(EXCLUDED)
100+
101+
.PHONY: wrap
102+
wrap: ensure_prerequisites
103+
@echo "Re wrapping modified files"
104+
powrap -m
105+
106+
SRCS = $(shell git diff --name-only $(BRANCH) | grep '.po$$')
107+
# foo/bar.po => $(POSPELL_TMP_DIR)/foo/bar.po.out
108+
DESTS = $(addprefix $(POSPELL_TMP_DIR)/,$(addsuffix .out,$(SRCS)))
109+
110+
.PHONY: spell
111+
spell: ensure_prerequisites $(DESTS)
112+
113+
.PHONY: line-length
114+
line-length:
115+
@echo "Searching for long lines..."
116+
@awk '{if (length(gensub(/శ్రీనివాస్/, ".", "g", $$0)) > 80 && length(gensub(/[^ ]/, "", "g")) > 1) {print FILENAME ":" FNR, "line too long:", $$0; ERRORS+=1}} END {if (ERRORS>0) {exit 1}}' *.po */*.po
117+
118+
.PHONY: sphinx-lint
119+
sphinx-lint:
120+
@echo "Checking all files using sphinx-lint..."
121+
@sphinx-lint --enable all --disable line-too-long *.po */*.po
122+
123+
$(POSPELL_TMP_DIR)/%.po.out: %.po dict
124+
@echo "Pospell checking $<..."
125+
@mkdir -p $(@D)
126+
pospell -p dict -l tr_TR $< && touch $@
127+
128+
.PHONY: fuzzy
129+
fuzzy: ensure_prerequisites
130+
potodo -f --exclude venv .venv $(EXCLUDED)
131+
132+
.PHONY: verifs
133+
verifs: spell line-length sphinx-lint
134+
135+
.PHONY: clean
136+
clean:
137+
@echo "Cleaning *.mo and $(POSPELL_TMP_DIR)"
138+
rm -rf $(POSPELL_TMP_DIR) locales/$(LANGUAGE)/LC_MESSAGES/
139+
find -name '*.mo' -delete
140+
@echo "Cleaning build directory"
141+
$(MAKE) -C venv/cpython/Doc/ clean

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# python-docs-fa
2+
3+
Hello! This is the repository of the fa translation of the Python documentation.
4+
5+
**You can refer to the following resources throughout this journey:**
6+
7+
- [DevGuide Translating Section](https://devguide.python.org/documentation/translating/) (add your translation to the list!)
8+
- [PEP 545](https://www.python.org/dev/peps/pep-0545/) (the PEP that describes the translation process)
9+
- [Other Translations](https://github.com/orgs/python/repositories?q=python-docs) (see how other translations are doing it)
10+
- [Python Docs Discord Server](https://discord.com/invite/sMWqvzXvde) (especially the `#translations` channel)
11+
12+
## Documentation Contribution Agreement
13+
Python's documentation is maintained using a global network of volunteers. By posting this project on Transifex, Github, and other public places, and inviting you to participate, we are proposing an agreement that you will provide your improvements to Python's documentation or the translation of Python's documentation for the PSF's use under the CC0 license (available at https://creativecommons.org/publicdomain/zero/1.0/legalcode). In return, you may publicly claim credit for the portion of the translation you contributed and if your translation is accepted by the PSF, you may (but are not required to) submit a patch including an appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although nothing in this Documentation Contribution Agreement obligates the PSF to incorporate your textual contribution, your participation in the Python community is welcomed and appreciated.
14+
15+
You signify acceptance of this agreement by submitting your work to the PSF for inclusion in the documentation.
16+
17+
***Do not forget to replace this file with your own README that describes your translation and community, while keeping the above agreement!***

about.po

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2001-2025, Python Software Foundation
3+
# This file is distributed under the same license as the Python package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Python 3.13\n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2025-02-10 02:51+0330\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <LL@li.org>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=UTF-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
19+
#: about.rst:3
20+
msgid "About this documentation"
21+
msgstr ""
22+
23+
#: about.rst:6
24+
msgid "Python's documentation is generated from `reStructuredText`_ sources using `Sphinx`_, a documentation generator originally created for Python and now maintained as an independent project."
25+
msgstr ""
26+
27+
#: about.rst:16
28+
msgid "Development of the documentation and its toolchain is an entirely volunteer effort, just like Python itself. If you want to contribute, please take a look at the :ref:`reporting-bugs` page for information on how to do so. New volunteers are always welcome!"
29+
msgstr ""
30+
31+
#: about.rst:21
32+
msgid "Many thanks go to:"
33+
msgstr ""
34+
35+
#: about.rst:23
36+
msgid "Fred L. Drake, Jr., the creator of the original Python documentation toolset and author of much of the content;"
37+
msgstr ""
38+
39+
#: about.rst:25
40+
msgid "the `Docutils <https://docutils.sourceforge.io/>`_ project for creating reStructuredText and the Docutils suite;"
41+
msgstr ""
42+
43+
#: about.rst:27
44+
msgid "Fredrik Lundh for his Alternative Python Reference project from which Sphinx got many good ideas."
45+
msgstr ""
46+
47+
#: about.rst:32
48+
msgid "Contributors to the Python documentation"
49+
msgstr ""
50+
51+
#: about.rst:34
52+
msgid "Many people have contributed to the Python language, the Python standard library, and the Python documentation. See :source:`Misc/ACKS` in the Python source distribution for a partial list of contributors."
53+
msgstr ""
54+
55+
#: about.rst:38
56+
msgid "It is only with the input and contributions of the Python community that Python has such wonderful documentation -- Thank You!"
57+
msgstr ""

bugs.po

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2001-2025, Python Software Foundation
3+
# This file is distributed under the same license as the Python package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Python 3.13\n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2025-02-10 02:51+0330\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <LL@li.org>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=UTF-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
19+
#: bugs.rst:5
20+
msgid "Dealing with Bugs"
21+
msgstr ""
22+
23+
#: bugs.rst:7
24+
msgid "Python is a mature programming language which has established a reputation for stability. In order to maintain this reputation, the developers would like to know of any deficiencies you find in Python."
25+
msgstr ""
26+
27+
#: bugs.rst:11
28+
msgid "It can be sometimes faster to fix bugs yourself and contribute patches to Python as it streamlines the process and involves less people. Learn how to :ref:`contribute <contributing-to-python>`."
29+
msgstr ""
30+
31+
#: bugs.rst:16
32+
msgid "Documentation bugs"
33+
msgstr ""
34+
35+
#: bugs.rst:18
36+
msgid "If you find a bug in this documentation or would like to propose an improvement, please submit a bug report on the :ref:`tracker <using-the-tracker>`. If you have a suggestion on how to fix it, include that as well."
37+
msgstr ""
38+
39+
#: bugs.rst:22
40+
msgid "You can also open a discussion item on our `Documentation Discourse forum <https://discuss.python.org/c/documentation/26>`_."
41+
msgstr ""
42+
43+
#: bugs.rst:25
44+
msgid "If you find a bug in the theme (HTML / CSS / JavaScript) of the documentation, please submit a bug report on the `python-doc-theme bug tracker <https://github.com/python/python-docs-theme>`_."
45+
msgstr ""
46+
47+
#: bugs.rst:29
48+
msgid "If you're short on time, you can also email documentation bug reports to docs@python.org (behavioral bugs can be sent to python-list@python.org). 'docs@' is a mailing list run by volunteers; your request will be noticed, though it may take a while to be processed."
49+
msgstr ""
50+
51+
#: bugs.rst:36
52+
msgid "`Documentation bugs`_"
53+
msgstr ""
54+
55+
#: bugs.rst:37
56+
msgid "A list of documentation bugs that have been submitted to the Python issue tracker."
57+
msgstr ""
58+
59+
#: bugs.rst:39
60+
msgid "`Issue Tracking <https://devguide.python.org/tracker/>`_"
61+
msgstr ""
62+
63+
#: bugs.rst:40
64+
msgid "Overview of the process involved in reporting an improvement on the tracker."
65+
msgstr ""
66+
67+
#: bugs.rst:42
68+
msgid "`Helping with Documentation <https://devguide.python.org/docquality/#helping-with-documentation>`_"
69+
msgstr ""
70+
71+
#: bugs.rst:43
72+
msgid "Comprehensive guide for individuals that are interested in contributing to Python documentation."
73+
msgstr ""
74+
75+
#: bugs.rst:45
76+
msgid "`Documentation Translations <https://devguide.python.org/documentation/translating/>`_"
77+
msgstr ""
78+
79+
#: bugs.rst:46
80+
msgid "A list of GitHub pages for documentation translation and their primary contacts."
81+
msgstr ""
82+
83+
#: bugs.rst:52
84+
msgid "Using the Python issue tracker"
85+
msgstr ""
86+
87+
#: bugs.rst:54
88+
msgid "Issue reports for Python itself should be submitted via the GitHub issues tracker (https://github.com/python/cpython/issues). The GitHub issues tracker offers a web form which allows pertinent information to be entered and submitted to the developers."
89+
msgstr ""
90+
91+
#: bugs.rst:59
92+
msgid "The first step in filing a report is to determine whether the problem has already been reported. The advantage in doing so, aside from saving the developers' time, is that you learn what has been done to fix it; it may be that the problem has already been fixed for the next release, or additional information is needed (in which case you are welcome to provide it if you can!). To do this, search the tracker using the search box at the top of the page."
93+
msgstr ""
94+
95+
#: bugs.rst:66
96+
msgid "If the problem you're reporting is not already in the list, log in to GitHub. If you don't already have a GitHub account, create a new account using the \"Sign up\" link. It is not possible to submit a bug report anonymously."
97+
msgstr ""
98+
99+
#: bugs.rst:71
100+
msgid "Being now logged in, you can submit an issue. Click on the \"New issue\" button in the top bar to report a new issue."
101+
msgstr ""
102+
103+
#: bugs.rst:74
104+
msgid "The submission form has two fields, \"Title\" and \"Comment\"."
105+
msgstr ""
106+
107+
#: bugs.rst:76
108+
msgid "For the \"Title\" field, enter a *very* short description of the problem; fewer than ten words is good."
109+
msgstr ""
110+
111+
#: bugs.rst:79
112+
msgid "In the \"Comment\" field, describe the problem in detail, including what you expected to happen and what did happen. Be sure to include whether any extension modules were involved, and what hardware and software platform you were using (including version information as appropriate)."
113+
msgstr ""
114+
115+
#: bugs.rst:84
116+
msgid "Each issue report will be reviewed by a developer who will determine what needs to be done to correct the problem. You will receive an update each time an action is taken on the issue."
117+
msgstr ""
118+
119+
#: bugs.rst:91
120+
msgid "`How to Report Bugs Effectively <https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_"
121+
msgstr ""
122+
123+
#: bugs.rst:92
124+
msgid "Article which goes into some detail about how to create a useful bug report. This describes what kind of information is useful and why it is useful."
125+
msgstr ""
126+
127+
#: bugs.rst:95
128+
msgid "`Bug Writing Guidelines <https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html>`_"
129+
msgstr ""
130+
131+
#: bugs.rst:96
132+
msgid "Information about writing a good bug report. Some of this is specific to the Mozilla project, but describes general good practices."
133+
msgstr ""
134+
135+
#: bugs.rst:102
136+
msgid "Getting started contributing to Python yourself"
137+
msgstr ""
138+
139+
#: bugs.rst:104
140+
msgid "Beyond just reporting bugs that you find, you are also welcome to submit patches to fix them. You can find more information on how to get started patching Python in the `Python Developer's Guide`_. If you have questions, the `core-mentorship mailing list`_ is a friendly place to get answers to any and all questions pertaining to the process of fixing issues in Python."
141+
msgstr ""

0 commit comments

Comments
 (0)