From 567ee49af7527f9f750c5e0d3b84b4d8122c0b58 Mon Sep 17 00:00:00 2001 From: Rafael Fontenelle Date: Thu, 28 Nov 2024 10:53:51 -0300 Subject: [PATCH 1/9] Create .readthedocs.yml (cherry picked from commit ff75313b1c1e5222d05971b7cb434962eb3dc365) --- .readthedocs.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..7d3909c07 --- /dev/null +++ b/.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 From 325faab265298bee12363d5298496b2f7b586b73 Mon Sep 17 00:00:00 2001 From: Rafael Fontenelle Date: Thu, 28 Nov 2024 10:56:50 -0300 Subject: [PATCH 2/9] Create documentation-links.yml (cherry picked from commit 5d16e733b07e4081f18816842f1067f3c806655a) --- .github/workflows/documentation-links.yml | 24 +++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/documentation-links.yml diff --git a/.github/workflows/documentation-links.yml b/.github/workflows/documentation-links.yml new file mode 100644 index 000000000..9454510db --- /dev/null +++ b/.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" From deaa9b3a140fa59995d07dd8063994dd6ac127a3 Mon Sep 17 00:00:00 2001 From: Rafael Fontenelle Date: Tue, 10 Dec 2024 17:51:19 -0300 Subject: [PATCH 3/9] Rename .readthedocs.yml to .readthedocs.yaml (cherry picked from commit 20705e51416705a9fa77803312f8e480264dd93d) --- .readthedocs.yml => .readthedocs.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .readthedocs.yml => .readthedocs.yaml (100%) diff --git a/.readthedocs.yml b/.readthedocs.yaml similarity index 100% rename from .readthedocs.yml rename to .readthedocs.yaml From d0d4c1c8a12fb10b588cff473f2c056d3f85c66c Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Tue, 18 Nov 2025 17:57:16 +0100 Subject: [PATCH 4/9] Update .readthedocs.yaml: moving build directory Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7d3909c07..47b62768b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,4 +14,4 @@ build: - asdf global uv latest - uv run generate.py - mkdir -p _readthedocs/html - - mv index.html style.css _readthedocs/html + - mv build/* _readthedocs/html From 961c7cd3bc31b4047ef23eb3409f49196537f297 Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Tue, 18 Nov 2025 18:00:03 +0100 Subject: [PATCH 5/9] Revert "Create documentation-links.yml" This reverts commit 325faab265298bee12363d5298496b2f7b586b73. --- .github/workflows/documentation-links.yml | 24 ----------------------- 1 file changed, 24 deletions(-) delete mode 100644 .github/workflows/documentation-links.yml diff --git a/.github/workflows/documentation-links.yml b/.github/workflows/documentation-links.yml deleted file mode 100644 index 9454510db..000000000 --- a/.github/workflows/documentation-links.yml +++ /dev/null @@ -1,24 +0,0 @@ -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" From 90ad98825b2b5962299098a5935ca702edf3b4e5 Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Tue, 18 Nov 2025 18:02:20 +0100 Subject: [PATCH 6/9] Install requirements --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 47b62768b..b4f86059e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,6 +12,7 @@ build: - asdf plugin add uv - asdf install uv latest - asdf global uv latest + - uv pip install -r requirements.txt - uv run generate.py - mkdir -p _readthedocs/html - mv build/* _readthedocs/html From 442383e63dd4c87325ec7bd3c7f4bc6508c61295 Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Tue, 18 Nov 2025 18:07:44 +0100 Subject: [PATCH 7/9] Run second generation script --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b4f86059e..b2be9b971 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,5 +14,6 @@ build: - asdf global uv latest - uv pip install -r requirements.txt - uv run generate.py + - uv run generate_build_details.py - mkdir -p _readthedocs/html - mv build/* _readthedocs/html From 29616ffe38a59d856b94688fe47e260e63388eac Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Tue, 18 Nov 2025 21:07:53 +0100 Subject: [PATCH 8/9] Simplify readthedocs script --- .readthedocs.yaml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b2be9b971..43b7c77db 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,11 +9,8 @@ build: tools: python: "3" commands: - - asdf plugin add uv - - asdf install uv latest - - asdf global uv latest - - uv pip install -r requirements.txt - - uv run generate.py - - uv run generate_build_details.py + - pip install -r requirements.txt + - python generate.py + - python generate_build_details.py - mkdir -p _readthedocs/html - mv build/* _readthedocs/html From 4263c4e38c9121f0ef38ad9e83bcbc13d932ef0f Mon Sep 17 00:00:00 2001 From: Maciej Olko Date: Tue, 18 Nov 2025 21:31:21 +0100 Subject: [PATCH 9/9] Revert "Run second generation script" This reverts commit 442383e6 The second script is too slow for our RTD tier --- .readthedocs.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 43b7c77db..ee76fba67 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,6 +11,5 @@ build: commands: - pip install -r requirements.txt - python generate.py - - python generate_build_details.py - mkdir -p _readthedocs/html - mv build/* _readthedocs/html