Merge pull request #54 from PyCampES/resources-index

Add useful resources to the index page

Author: raulcd

CONTRIBUTING.rst renamed to .overrides/CONTRIBUTING.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

.overrides/README.rst

@@ -0,0 +1,13 @@
+{%- if show_source and has_source and sourcename %}
+<div role="note" aria-label="source link">
+    <h3>{{ _('This Page') }}</h3>
+    <ul class="this-page-menu">
+        <li><a href="{{ pathto('bugs') }}">{% trans %}Report a Bug{% endtrans %}</a></li>
+        <li>
+            <a href="https://github.com/PyCampES/python-docs-es/blob/{{ version }}/{{ sourcename|replace('.rst.txt', '.po') }}"
+               rel="nofollow">{{ _('Show Source') }}
+            </a>
+        </li>
+    </ul>
+</div>
+{%- endif %}

.overrides/tools/templates/customsourcelink.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>

.overrides/tools/templates/indexsidebar.html

@@ -33,7 +33,22 @@
 
 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', '').lstrip('/')
+        outputdir = os.path.join(
+            'cpython',
+            'Doc',
+            destroot,
+            fname,
+        )
+        os.system(f'ln -nfs `pwd`/{root}/{fname} {outputdir}')
 
 gettext_compact = False
 locale_dirs = ['../locales', 'cpython/locales']  # relative to the sourcedir