Wrap commands.rst and fix warning (#121)

* Wrap commands.rst and remove default commen in index.rst

* Fix Furo warning

* Clean up

Author: StanFromIreland

docs/commands.rst

@@ -2,20 +2,21 @@
 Commands for maintaining language repository
 ============================================
 
-This document contains instructions to guide you on managing your language repository, hence helping you to translate Python's documentation to your language.
+This document contains instructions to guide you on managing your language repository, hence helping you to translate
+Python's documentation to your language.
 
-These commands are written as in Linux Shell, and should work in Windows Subsystem Linux (WSL), but feel free to use the same logic in other languages e.g. Python.
+These commands are written as in Linux Shell, and should work in Windows Subsystem Linux (WSL), but feel free to use the
+same logic in other languages e.g. Python.
 
-Note: Where you see ``${LANGCODE}`` in the commands below, replace it with your language code (e.g. 'uk', 'pt_BR') or set that variable (e.g. ``LANGCODE=pt_BR``) before running the commands.
-
-.. contents:: Table of Contents
-    :depth: 2
+Note: Where you see ``${LANGCODE}`` in the commands below, replace it with your language code (e.g. 'uk', 'pt_BR') or
+set that variable (e.g. ``LANGCODE=pt_BR``) before running the commands.
 
 
 Clone CPython repository
 ------------------------
 
-It is necessary to have a local clone of CPython's source code repository in order to update translation files and to build translated documentation.
+It is necessary to have a local clone of CPython's source code repository in order to update translation files and to
+build translated documentation.
 
 From inside your language repository, run:
 
@@ -26,7 +27,9 @@ From inside your language repository, run:
 
 ``--depth 1`` do a shallow clone, which avoid downloading all the 800 MB of data from CPython's repository.
 
-Optionally, you could also add ``--no-single-branch`` to git clone command which would make all branches available, allowing to switch between one branch and another. But there is no need if you are working in the translation of a single branch.
+Optionally, you could also add ``--no-single-branch`` to git clone command which would make all branches available,
+allowing to switch between one branch and another. But there is no need if you are working in the translation of a
+single branch.
 
 
 Install requirements
@@ -35,7 +38,8 @@ Install requirements
 Creating virtual environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Optionally, create a virtual environment (short: venv) to keep all Python package installations in it, then activate this venv to make sure commands are run from it:
+Optionally, create a virtual environment (short: venv) to keep all Python package installations in it, then activate
+this venv to make sure commands are run from it:
 
 .. code-block:: shell
 
@@ -65,15 +69,21 @@ Install the Transifex CLI client, required to interact with Transifex:
    curl -s -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh
    cd ../..
 
-Note: the above statements cause ``tx`` binary to be downloaded into .venv/bin directory. Feel free to install this tool wherever you want, but preferably in a directory already in the PATH so that issuing  ``tx`` works without its full path.
+Note: the above statements cause ``tx`` binary to be downloaded into .venv/bin directory. Feel free to install this
+tool wherever you want, but preferably in a directory already in the PATH so that issuing  ``tx`` works without its
+full path.
 
 
 Updating the translations
 -------------------------
 
-For language teams that coordinate translation efforts in Transifex, updating translation means pulling the translation strings.
+For language teams that coordinate translation efforts in Transifex, updating translation means pulling the translation
+strings.
 
-Recommended: Before pulling translations, consider updating the .tx/config to have an up-to-date mapping of project/resources. For this, it is required to generate the documentation's pot files (template of po files), so start with the pot. Alternatively, you can skip it and pull translations, but new translation resources in Transifex could be not mapped, hence wouldn't be pulled.
+Recommended: Before pulling translations, consider updating the .tx/config to have an up-to-date mapping of
+project/resources. For this, it is required to generate the documentation's pot files (template of po files),
+so start with the pot. Alternatively, you can skip it and pull translations, but new translation resources in Transifex
+could be not mapped, hence wouldn't be pulled.
 
 Generating pot files
 ^^^^^^^^^^^^^^^^^^^^
@@ -100,9 +110,11 @@ Having the pot files, make use of sphinx-intl to generate the .tx/config:
        --transifex-project-name=python-newest \
        --locale-dir . --pot-dir pot
 
-This step should take some time to finish. Once it is done, there should be a cpython/Doc/locales/.tx/config containing the list of resources based on the pot files previously generated.
+This step should take some time to finish. Once it is done, there should be a cpython/Doc/locales/.tx/config containing
+the list of resources based on the pot files previously generated.
 
-As a final touch, we copy the .tx/config into the language repository making proper tweaks so one can download translations from Transifex or upload local translation changes, all this from repository's root directory:
+As a final touch, we copy the .tx/config into the language repository making proper tweaks so one can download
+translations from Transifex or upload local translation changes, all this from repository's root directory:
 
 .. code-block:: shell
 
@@ -155,11 +167,15 @@ The following commands are recommended for committing and pushing your translati
    git add $(git ls-files -o --exclude-standard *.po **/*.po) .tx/config
    git diff-index --quiet HEAD || { git commit -m "Update translations" && git push; }
 
-It is not recommended to simply "git add" (stage) all PO files because this would also staged and commit the translation files that have only irrelevant changes in their POT-Creation-Date header field (i.e. date when the PO was updated against the POT).
+It is not recommended to simply "git add" (stage) all PO files because this would also staged and commit the translation
+files that have only irrelevant changes in their POT-Creation-Date header field (i.e. date when the PO was updated against
+the POT).
 
-The first command first git-add modified tracked files that does **not** exclusively match changes in POT-Creation-Date header, hence relevant changes are included.
+The first command first git-add modified tracked files that does **not** exclusively match changes in POT-Creation-Date
+header, hence relevant changes are included.
 
-The second command will git-add untracked po files that may have been newly created on the latest 'tx pull' run. It also adds .tx/config file.
+The second command will git-add untracked po files that may have been newly created on the latest 'tx pull' run. It also
+adds .tx/config file.
 
 The last command will only commit and push if any file was git-added in the above commands.
 
@@ -194,7 +210,8 @@ Finally, build using the Makefile from CPython's Doc directory. Here is an expla
 Viewing the documentation in a web browser
 -----------------------------------------
 
-Just build translated documentation and then open in the browser, no secrets. See below a one-line command to use your default web browser to open the index.html:
+Just build translated documentation and then open in the browser, no secrets. See below a one-line command to use your
+default web browser to open the index.html:
 
 .. code-block:: shell
 
@@ -206,7 +223,8 @@ Notice how index.html could be replaced with any page, e.g. 'library/os.html'.
 Linting the translation files
 -----------------------------
 
-``sphinx-lint`` is great to spot translation errors that will didn't spot e.g. trailing whitespace in the string, reST directive not properly surrounded with whitespace, etc. It's highly recommended.
+``sphinx-lint`` is great to spot translation errors that will didn't spot e.g. trailing whitespace in the string, reST
+directive not properly surrounded with whitespace, etc. It's highly recommended.
 
 .. code-block:: shell
 
@@ -216,7 +234,9 @@ Linting the translation files
 Merging translations into another branch
 ----------------------------------------
 
-This is useful when you want to replicate a translation from the CPython branch currently being translated to another older branch. E.g. 3.12 is currently being translated, but 3.11 has that same string and could make use of the translation contributed.
+This is useful when you want to replicate a translation from the CPython branch currently being translated to another
+older branch. E.g. 3.12 is currently being translated, but 3.11 has that same string and could make use of the
+translation contributed.
 
 .. code-block:: shell
 
@@ -226,7 +246,8 @@ This is useful when you want to replicate a translation from the CPython branch
    git checkout ${TARGET_BRANCH}
    pomerge --to-files *.po **/*.po
 
-After the above command, the translation from the current branch were applied to the previous branch "3.11". Now, let's make sure lines are wrapped:
+After the above command, the translation from the current branch were applied to the previous branch "3.11". Now, let's
+make sure lines are wrapped:
 
 .. code-block:: shell
 

docs/index.rst

@@ -1,10 +1,5 @@
-.. Python Docs Transifex Automations documentation master file, created by
-   sphinx-quickstart on Sun Jan 26 11:03:05 2025.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Python Docs Transifex Automations documentation
-================================================
+===============================================
 
 Scripts and procedures for maintaining Python_ documentation translation infrastructure under python-doc_ organization in Transifex_.