From 5df8a959f54b2214af77280502b4129fb97640bb Mon Sep 17 00:00:00 2001 From: mahiro <70263039+mahiro72@users.noreply.github.com> Date: Fri, 5 Dec 2025 16:53:08 +0900 Subject: [PATCH] Update mkdocs-material to 9.7.0 (Insiders now free) (#21797) --- .github/renovate.json5 | 8 -------- .github/workflows/ci.yaml | 17 +---------------- .github/workflows/publish-docs.yml | 20 +------------------- CONTRIBUTING.md | 13 +------------ docs/requirements-insiders.txt | 8 -------- docs/requirements.txt | 2 +- mkdocs.public.yml | 6 ------ mkdocs.insiders.yml => mkdocs.yml | 0 8 files changed, 4 insertions(+), 70 deletions(-) delete mode 100644 docs/requirements-insiders.txt delete mode 100644 mkdocs.public.yml rename mkdocs.insiders.yml => mkdocs.yml (100%) diff --git a/.github/renovate.json5 b/.github/renovate.json5 index 449ea573f0..c6a8b29a76 100644 --- a/.github/renovate.json5 +++ b/.github/renovate.json5 @@ -75,14 +75,6 @@ matchManagers: ["cargo"], enabled: false, }, - { - // `mkdocs-material` requires a manual update to keep the version in sync - // with `mkdocs-material-insider`. - // See: https://squidfunk.github.io/mkdocs-material/insiders/upgrade/ - matchManagers: ["pip_requirements"], - matchPackageNames: ["mkdocs-material"], - enabled: false, - }, { groupName: "pre-commit dependencies", matchManagers: ["pre-commit"], diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 64e5e2163c..83b6b83bc3 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -779,8 +779,6 @@ jobs: name: "mkdocs" runs-on: ubuntu-latest timeout-minutes: 10 - env: - MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} steps: - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 with: @@ -788,11 +786,6 @@ jobs: - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2 with: save-if: ${{ github.ref == 'refs/heads/main' }} - - name: "Add SSH key" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - uses: webfactory/ssh-agent@a6f90b1f127823b31d4d4a8d96047790581349bd # v0.9.1 - with: - ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} - name: "Install Rust toolchain" run: rustup show - name: Install uv @@ -800,11 +793,7 @@ jobs: with: python-version: 3.13 activate-environment: true - - name: "Install Insiders dependencies" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - run: uv pip install -r docs/requirements-insiders.txt - name: "Install dependencies" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} run: uv pip install -r docs/requirements.txt - name: "Update README File" run: python scripts/transform_readme.py --target mkdocs @@ -812,12 +801,8 @@ jobs: run: python scripts/generate_mkdocs.py - name: "Check docs formatting" run: python scripts/check_docs_formatted.py - - name: "Build Insiders docs" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - run: mkdocs build --strict -f mkdocs.insiders.yml - name: "Build docs" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} - run: mkdocs build --strict -f mkdocs.public.yml + run: mkdocs build --strict -f mkdocs.yml check-formatter-instability-and-black-similarity: name: "formatter instabilities and black similarity" diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 000b866c48..bd72c6a766 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -20,8 +20,6 @@ on: jobs: mkdocs: runs-on: ubuntu-latest - env: - MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} steps: - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 with: @@ -59,23 +57,12 @@ jobs: echo "branch_name=update-docs-$branch_display_name-$timestamp" >> "$GITHUB_ENV" echo "timestamp=$timestamp" >> "$GITHUB_ENV" - - name: "Add SSH key" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - uses: webfactory/ssh-agent@a6f90b1f127823b31d4d4a8d96047790581349bd # v0.9.1 - with: - ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} - - name: "Install Rust toolchain" run: rustup show - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2 - - name: "Install Insiders dependencies" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - run: pip install -r docs/requirements-insiders.txt - - name: "Install dependencies" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} run: pip install -r docs/requirements.txt - name: "Copy README File" @@ -83,13 +70,8 @@ jobs: python scripts/transform_readme.py --target mkdocs python scripts/generate_mkdocs.py - - name: "Build Insiders docs" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - run: mkdocs build --strict -f mkdocs.insiders.yml - - name: "Build docs" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} - run: mkdocs build --strict -f mkdocs.public.yml + run: mkdocs build --strict -f mkdocs.yml - name: "Clone docs repo" run: git clone https://${{ secrets.ASTRAL_DOCS_PAT }}@github.com/astral-sh/docs.git astral-docs diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb6758451f..1851d45199 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -331,13 +331,6 @@ you addressed them. ## MkDocs -> [!NOTE] -> -> The documentation uses Material for MkDocs Insiders, which is closed-source software. -> This means only members of the Astral organization can preview the documentation exactly as it -> will appear in production. -> Outside contributors can still preview the documentation, but there will be some differences. Consult [the Material for MkDocs documentation](https://squidfunk.github.io/mkdocs-material/insiders/benefits/#features) for which features are exclusively available in the insiders version. - To preview any changes to the documentation locally: 1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install). @@ -351,11 +344,7 @@ To preview any changes to the documentation locally: 1. Run the development server with: ```shell - # For contributors. - uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.public.yml - - # For members of the Astral org, which has access to MkDocs Insiders via sponsorship. - uvx --with-requirements docs/requirements-insiders.txt -- mkdocs serve -f mkdocs.insiders.yml + uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.yml ``` The documentation should then be available locally at diff --git a/docs/requirements-insiders.txt b/docs/requirements-insiders.txt deleted file mode 100644 index 9726b8ab5a..0000000000 --- a/docs/requirements-insiders.txt +++ /dev/null @@ -1,8 +0,0 @@ -PyYAML==6.0.3 -ruff==0.14.7 -mkdocs==1.6.1 -mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@39da7a5e761410349e9a1b8abf593b0cdd5453ff -mkdocs-redirects==1.2.2 -mdformat==0.7.22 -mdformat-mkdocs==4.4.2 -mkdocs-github-admonitions-plugin @ git+https://github.com/PGijsbers/admonitions.git#7343d2f4a92e4d1491094530ef3d0d02d93afbb7 diff --git a/docs/requirements.txt b/docs/requirements.txt index a9b415267f..c80ac6c61b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,7 @@ PyYAML==6.0.3 ruff==0.14.7 mkdocs==1.6.1 -mkdocs-material==9.5.38 +mkdocs-material==9.7.0 mkdocs-redirects==1.2.2 mdformat==0.7.22 mdformat-mkdocs==4.4.2 diff --git a/mkdocs.public.yml b/mkdocs.public.yml deleted file mode 100644 index b6d7ae6eca..0000000000 --- a/mkdocs.public.yml +++ /dev/null @@ -1,6 +0,0 @@ -INHERIT: mkdocs.generated.yml -# Omit the `typeset` plugin which is only available in the Insiders version. -plugins: - - search -watch: - - mkdocs.generated.yml diff --git a/mkdocs.insiders.yml b/mkdocs.yml similarity index 100% rename from mkdocs.insiders.yml rename to mkdocs.yml