Enable Read-The-Docs // Add pre-commit // Fix any issues with existing translations (#536)

* Enable Read-The-Docs and fix any issues with existing translations
* Do not check cpython dir for changed files in CI
* Update pre-commit version
* [pre-commit.ci lite] apply automatic fixes
* Use commit hashes everywhere

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-authored-by: George Margaritis <[email protected]>

Author: 3 people

.github/workflows/main.yaml

@@ -0,0 +1,29 @@
+name: Run pre-commit
+
+on:
+  push:
+    branches:
+      - 3.*
+      - main
+  pull_request:
+
+jobs:
+  test:
+    name: Run pre-commit.ci
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          submodules: "true"
+          fetch-depth: 2
+      - name: Setup python
+        uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5.1.1
+        with:
+          python-version: "3.x"
+      - name: Install system deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y hunspell hunspell-el gettext language-pack-el locales-all
+      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+      - uses: pre-commit-ci/lite-action@9d882e7a565f7008d4faf128f27d1cb6503d4ebf # v1.0.2
+        if: always()

.github/workflows/precommit.yaml

@@ -158,3 +158,9 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+locales/
+.potodo/
+
+# VS Code
+.vscode/

.gitignore

@@ -0,0 +1,3 @@
+[submodule "cpython"]
+	path = cpython
+	url = https://github.com/python/cpython

.gitmodules

@@ -0,0 +1,28 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c # v4.6.0
+    hooks:
+      - id: file-contents-sorter
+        files: "dictionaries/main.txt"
+        args: ["--unique"]
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: end-of-file-fixer
+
+  - repo: https://git.afpy.org/AFPy/powrap
+    rev: df2a0a54804a6146cc9fbffb77464d4b5fe24f41 # v1.0.1
+    hooks:
+      - id: powrap
+
+  - repo: https://git.afpy.org/AFPy/pospell
+    rev: 8b753bde26fe612ba397a4b4aafa7a0560402805 # v1.3
+    hooks:
+      - id: pospell
+        args:
+          - "--language=el_GR"
+          - "--personal-dict=dictionaries/main.txt"
+
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: ce6d7aeab24d60b6119dbad180540bf3c9ff31da # v0.9.1
+    hooks:
+      - id: sphinx-lint

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+
+  commands:
+  - python -m pip install -r requirements.txt
+  - make
+  - mkdir -p _readthedocs/html/
+  - cp -r cpython/Doc/build/html/* _readthedocs/html/
+
+python:
+  install:
+    - requirements: requirements.txt
+
+submodules:
+  include: all

.readthedocs.yaml

@@ -23,9 +23,10 @@
 # .po files.
 CPYTHON_CURRENT_COMMIT := 9cbde7c6ce6f7b93301a37f03dfa0c0d45e00a39
 
-CPYTHON_PATH := /home/tpetkos/github.com/python/cpython/
+CPYTHON_PATH := ./cpython
 
-LANGUAGE := gr
+LANGUAGE := el
+TRANSLATION_BRANCH := main
 BRANCH := 3.12
 
 EXCLUDED := whatsnew/ c-api/
@@ -36,7 +37,7 @@ UPSTREAM := https://github.com/python/cpython
 
 PYTHON := $(shell which python3)
 MODE := html
-POSPELL_TMP_DIR := .pospell/
+POSPELL_TMP_DIR := .pospell
 JOBS := auto
 
 # Detect OS
@@ -58,7 +59,6 @@ endif
 
 .PHONY: all
 all: ensure_prerequisites
-	git -C $(CPYTHON_PATH) checkout $(CPYTHON_CURRENT_COMMIT)
 	mkdir -p locales/$(LANGUAGE)/LC_MESSAGES/
 	$(CP_CMD) -u --parents *.po */*.po locales/$(LANGUAGE)/LC_MESSAGES/
 	$(MAKE) -C $(CPYTHON_PATH)/Doc/     \
@@ -70,7 +70,6 @@ all: ensure_prerequisites
 	  -D latex_elements.inputenc=       \
 	  -D latex_elements.fontenc='       \
 	  $(MODE)
-	git -C $(CPYTHON_PATH) checkout -
 	@echo "Build success, open file://$(abspath $(CPYTHON_PATH))/Doc/build/html/index.html or run 'make serve' to see them."
 
 
@@ -83,10 +82,7 @@ ensure_prerequisites:
 	@if ! [ -d $(CPYTHON_PATH) ]; then \
 	    echo "Building the translation requires a cpython clone."; \
 	    echo "Please provide the path to a clone using the CPYTHON_PATH variable."; \
-	    echo "(Currently CPYTHON_PATH is $(CPYTHON_PATH)."; \
-	    echo "So you may want to run:"; \
-	    echo ""; \
-	    echo "  git clone $(UPSTREAM) $(CPYTHON_PATH)"; \
+	    echo "(Currently CPYTHON_PATH is $(CPYTHON_PATH).)"; \
 	    exit 1; \
 	fi
 	@if [ -n "$$(git -C $(CPYTHON_PATH) status --porcelain)" ]; then \
@@ -95,16 +91,16 @@ ensure_prerequisites:
 	    exit 1; \
 	fi
 	@if ! (blurb help >/dev/null 2>&1 && sphinx-build --version >/dev/null 2>&1); then \
-	    git -C $(CPYTHON_PATH) checkout $(BRANCH); \
 	    echo "You're missing dependencies, please enable a venv and install:"; \
 	    echo ""; \
-	    echo "  python -m pip install -r requirements.txt -r $(CPYTHON_PATH)/Doc/requirements.txt"; \
+	    echo "  python -m pip install -r requirements.txt"; \
 	    exit 1; \
 	fi
 
+
 .PHONY: serve
 serve:
-	$(MAKE) -C $(CPYTHON_PATH)/Doc/ serve
+	$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('cpython/Doc/build/html/index.html'))"
 
 
 .PHONY: progress
@@ -123,7 +119,7 @@ wrap: ensure_prerequisites
 	@echo "Verify wrapping"
 	powrap --check --quiet *.po **/*.po
 
-SRCS = $(shell git diff --name-only $(BRANCH) | grep '.po$$')
+SRCS = $(shell git diff --name-only $(TRANSLATION_BRANCH) | grep '.po$$')
 # foo/bar.po => $(POSPELL_TMP_DIR)/foo/bar.po.out
 DESTS = $(addprefix $(POSPELL_TMP_DIR)/,$(addsuffix .out,$(SRCS)))
 

Makefile

@@ -6,7 +6,7 @@
 ΣΗΜΕΙΩΣΗ ΓΙΑ ΤΗΝ ΑΔΕΙΑ ΧΡΗΣΗΣ ΤΩΝ ΜΕΤΑΦΡΑΣΕΩΝ
 
 Ο οδηγός χρήσης της Python συντηρείται από ένα παγκόσμιο δίκτυο
-εθελοντών. 
+εθελοντών.
 
 Αυτό το έργο πρότζεκτ αποτελεί μια συνεργασία ανάμεσα σε εθελοντές μεταφραστές και
 της ομάδας python-docs-gr. Το παρόν έγγραφο καθορίζει τα δικαιώματα και τις ευθύνες

README.md

@@ -2,4 +2,4 @@ Georgios Zisopoulos
 Lysandros Nikolaou
 Theofanis Petkos
 Panagiotis Skias
-Dimitrios Papadopoulos
+Dimitrios Papadopoulos

TRANSLATORS

@@ -382,48 +382,34 @@ msgid ""
 "flags below it."
 msgstr ""
 
-#: c-api/buffer.rst:306
-#: c-api/buffer.rst:331
+#: c-api/buffer.rst:306 c-api/buffer.rst:331
 msgid "Request"
 msgstr ""
 
-#: c-api/buffer.rst:306
-#: c-api/buffer.rst:331
+#: c-api/buffer.rst:306 c-api/buffer.rst:331
 msgid "shape"
 msgstr ""
 
-#: c-api/buffer.rst:306
-#: c-api/buffer.rst:331
+#: c-api/buffer.rst:306 c-api/buffer.rst:331
 msgid "strides"
 msgstr ""
 
-#: c-api/buffer.rst:306
-#: c-api/buffer.rst:331
+#: c-api/buffer.rst:306 c-api/buffer.rst:331
 msgid "suboffsets"
 msgstr ""
 
-#: c-api/buffer.rst:286
-#: c-api/buffer.rst:308
-#: c-api/buffer.rst:312
-#: c-api/buffer.rst:333
-#: c-api/buffer.rst:337
-#: c-api/buffer.rst:341
-#: c-api/buffer.rst:345
-#: c-api/buffer.rst:347
+#: c-api/buffer.rst:286 c-api/buffer.rst:308 c-api/buffer.rst:312
+#: c-api/buffer.rst:333 c-api/buffer.rst:337 c-api/buffer.rst:341
+#: c-api/buffer.rst:345 c-api/buffer.rst:347
 msgid "yes"
 msgstr ""
 
-#: c-api/buffer.rst:333
-#: c-api/buffer.rst:335
+#: c-api/buffer.rst:333 c-api/buffer.rst:335
 msgid "if needed"
 msgstr ""
 
-#: c-api/buffer.rst:288
-#: c-api/buffer.rst:308
-#: c-api/buffer.rst:312
-#: c-api/buffer.rst:337
-#: c-api/buffer.rst:341
-#: c-api/buffer.rst:345
+#: c-api/buffer.rst:288 c-api/buffer.rst:308 c-api/buffer.rst:312
+#: c-api/buffer.rst:337 c-api/buffer.rst:341 c-api/buffer.rst:345
 #: c-api/buffer.rst:347
 msgid "NULL"
 msgstr ""
@@ -443,8 +429,7 @@ msgstr ""
 msgid "contig"
 msgstr ""
 
-#: c-api/buffer.rst:314
-#: c-api/buffer.rst:347
+#: c-api/buffer.rst:314 c-api/buffer.rst:347
 msgid "C"
 msgstr ""
 
@@ -485,19 +470,15 @@ msgstr ""
 msgid "format"
 msgstr ""
 
-#: c-api/buffer.rst:335
-#: c-api/buffer.rst:339
-#: c-api/buffer.rst:343
+#: c-api/buffer.rst:335 c-api/buffer.rst:339 c-api/buffer.rst:343
 msgid "U"
 msgstr ""
 
-#: c-api/buffer.rst:337
-#: c-api/buffer.rst:345
+#: c-api/buffer.rst:337 c-api/buffer.rst:345
 msgid "0"
 msgstr ""
 
-#: c-api/buffer.rst:339
-#: c-api/buffer.rst:347
+#: c-api/buffer.rst:339 c-api/buffer.rst:347
 msgid "1 or 0"
 msgstr ""