Merge branch 'main' into check-against-latest

Author: m-aciek

.github/workflows/documentation-links.yml

@@ -0,0 +1,24 @@
+name: Read the Docs PR preview
+# Automatically edits a pull request's descriptions with a link
+# to the documentation's preview on Read the Docs.
+
+on:
+  pull_request_target:
+    types:
+      - opened
+
+permissions:
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "pydocs-translation-dashboard"
+          single-version: "true"

.github/workflows/update.yml

@@ -12,9 +12,11 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/setup-python@main
-      - uses: astral-sh/setup-uv@main
-      - uses: actions/checkout@main
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - uses: astral-sh/setup-uv@v4
+      - uses: actions/checkout@v4
       - run: sudo apt-get install -y gettext
       - run: uv run generate.py  # generates "index.html"
       - run: mkdir -p build && cp index.html style.css build
@@ -30,3 +32,7 @@ jobs:
           curl -Lo index.html-public https://github.com/m-aciek/pydocs-translation-dashboard/raw/refs/heads/gh-pages/index.html
           diff --color=always -u index.html-public index.html || :
           cat index.html
+      - uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: build

.readthedocs.yml

@@ -0,0 +1,17 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Project page: https://app.readthedocs.org/projects/pydocs-translation-dashboard/
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3"
+  commands:
+    - asdf plugin add uv
+    - asdf install uv latest
+    - asdf global uv latest
+    - uv run generate.py
+    - mkdir -p _readthedocs/html
+    - mv index.html style.css _readthedocs/html

generate.py

@@ -56,7 +56,11 @@
 <tbody>
 {% for language, completion in completion_progress | sort(attribute=1) | reverse %}
 <tr>
-  <td data-label="language">{{ language }}</td>
+  <td data-label="language">
+    <a href="https://github.com/python/python-docs-{{ language }}" target="_blank">
+      {{ language }}
+    </a>
+  </td>
   <td data-label="completion">
     <div class="progress-bar" style="width: {{ completion | round(2) }}%;">{{ completion | round(2) }}%</div>
   </td>
@@ -65,6 +69,7 @@
 </tbody>
 </table>
 <p>Last updated at {{ generation_time.strftime('%A, %d %B %Y, %X %Z') }}.</p>
+<p>Note that the completion value is based on files available in language Git repository and <a href="https://github.com/m-aciek/pydocs-translation-dashboard/issues/2" target="_blank">may not include</a> e.g. resources which translation hasn't yet started.</p>
 </body>
 </html>""")