From 6ffe95915a885d0076a6cbd9963df3be2ec8efa9 Mon Sep 17 00:00:00 2001 From: Kristof Herrmann Date: Fri, 13 Jun 2025 09:52:13 +0200 Subject: [PATCH 1/4] fix --- .github/workflows/api-docs.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/api-docs.yaml b/.github/workflows/api-docs.yaml index 8f3bd5d9..6711cb0f 100644 --- a/.github/workflows/api-docs.yaml +++ b/.github/workflows/api-docs.yaml @@ -4,6 +4,9 @@ on: release: types: - published + pull_request: + branches: + - main env: CATEGORY_ID: ${{ secrets.CATEGORY_ID }} @@ -63,4 +66,4 @@ jobs: - name: Run `docs` command 🚀 uses: readmeio/rdme@v10 with: - rdme: docs docs/_pydoc/temp --key=${{ secrets.README_API_KEY }} --version=1.0 + rdme: "docs docs/_pydoc/temp --key=${{ secrets.README_API_KEY }} --version=1.0" From 8b6b9a4d6902701c1c2683a02dd6636f7462bd81 Mon Sep 17 00:00:00 2001 From: Kristof Herrmann Date: Fri, 13 Jun 2025 09:55:09 +0200 Subject: [PATCH 2/4] fix --- .github/workflows/api-docs.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/api-docs.yaml b/.github/workflows/api-docs.yaml index 6711cb0f..aaa5518f 100644 --- a/.github/workflows/api-docs.yaml +++ b/.github/workflows/api-docs.yaml @@ -52,10 +52,10 @@ jobs: - name: Install dependencies for doc deployment run: pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin mike - - name: Publish docs to pages - run: | - mike deploy --push --update-aliases ${{github.ref_name}} && \ - mike set-default --push ${{github.ref_name}} + # - name: Publish docs to pages + # run: | + # mike deploy --push --update-aliases ${{github.ref_name}} && \ + # mike set-default --push ${{github.ref_name}} - name: Add Category ID to all API docs run: python ./.github/utils/add-category-id.py From fa83a0b69d61e18a8fed32f33aad02141e2d2019 Mon Sep 17 00:00:00 2001 From: Kristof Herrmann Date: Fri, 13 Jun 2025 10:04:39 +0200 Subject: [PATCH 3/4] fix --- .github/workflows/api-docs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/api-docs.yaml b/.github/workflows/api-docs.yaml index aaa5518f..ece99adf 100644 --- a/.github/workflows/api-docs.yaml +++ b/.github/workflows/api-docs.yaml @@ -64,6 +64,6 @@ jobs: CATEGORY_ID: ${{env.CATEGORY_ID}} - name: Run `docs` command 🚀 - uses: readmeio/rdme@v10 + uses: readmeio/rdme@v8 with: - rdme: "docs docs/_pydoc/temp --key=${{ secrets.README_API_KEY }} --version=1.0" + rdme: docs docs/_pydoc/temp --key=${{ secrets.README_API_KEY }} --version=1.0 From 213c097e5047dca42db9fc92385593e595e9626e Mon Sep 17 00:00:00 2001 From: Kristof Herrmann Date: Fri, 13 Jun 2025 10:08:28 +0200 Subject: [PATCH 4/4] fix: downgrade readme --- .github/workflows/api-docs.yaml | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/workflows/api-docs.yaml b/.github/workflows/api-docs.yaml index ece99adf..e72a211a 100644 --- a/.github/workflows/api-docs.yaml +++ b/.github/workflows/api-docs.yaml @@ -4,9 +4,6 @@ on: release: types: - published - pull_request: - branches: - - main env: CATEGORY_ID: ${{ secrets.CATEGORY_ID }} @@ -52,10 +49,10 @@ jobs: - name: Install dependencies for doc deployment run: pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin mike - # - name: Publish docs to pages - # run: | - # mike deploy --push --update-aliases ${{github.ref_name}} && \ - # mike set-default --push ${{github.ref_name}} + - name: Publish docs to pages + run: | + mike deploy --push --update-aliases ${{github.ref_name}} && \ + mike set-default --push ${{github.ref_name}} - name: Add Category ID to all API docs run: python ./.github/utils/add-category-id.py