Add useful resources to the index page

python · raulcd · May 4, 2020 · May 4, 2020 · May 4, 2020 · May 4, 2020
commit 3b82ef2c02ac6fe43594b81d9c02d094fa17a5db
diff --git a/CONTRIBUTING.rst → .overrides/CONTRIBUTING.rst b/CONTRIBUTING.rst → .overrides/CONTRIBUTING.rst
diff --git a/.overrides/README.rst b/.overrides/README.rst
@@ -0,0 +1,11 @@
+Overrides
+=========
+
+This directory is recursively copied into `cpython/Doc`.
+It needs to have the same structure than `cpython/Doc`.
+
+It allows us
+
+- to have our own `CONTRIBUTING.rst` guide
+- change the index sidebar with links that are interesting for translators
+- etc
diff --git a/.overrides/tools/templates/indexsidebar.html b/.overrides/tools/templates/indexsidebar.html
@@ -0,0 +1,11 @@
+<h3>¡Ayúdanos a traducir!</h3>
+<ul>
+  <li><a href="CONTRIBUTING.html">Guía para contribuir</a></li>
+</ul>
+
+<h3>Recursos</h3>
+<ul>
+  <li><a href="https://mail.python.org/mailman3/lists/docs-es.python.org/">Lista de correos</a></li>
+  <li><a href="https://t.me/python_docs_es">Canal de Télegram</a></li>
+  <li><a href="https://github.com/PyCampES/python-docs-es">Repositorio GitHub</a></li>
+</ul>
diff --git a/conf.py b/conf.py
@@ -33,7 +33,16 @@
 
 os.system('mkdir -p cpython/locales/es/')
 os.system('ln -nfs `pwd` cpython/locales/es/LC_MESSAGES')
-os.system('ln -nfs `pwd`/CONTRIBUTING.rst cpython/Doc/CONTRIBUTING.rst')
+
+
+# Override all the files from ``.overrides`` directory
+import glob
+for root, dirs, files in os.walk('.overrides'):
+    for fname in files:
+        if fname == 'README.rst' and root == '.overrides':
+            continue
+        destroot = root.replace('.overrides/', '')
+        os.system(f'ln -nfs `pwd`/{root}/{fname} cpython/Doc/{destroot}/{fname}')
 
 gettext_compact = False
 locale_dirs = ['../locales', 'cpython/locales']  # relative to the sourcedir