Update mkdocs-material to 9.7.0

.github/workflows/ci.yaml

@@ -101,24 +101,13 @@ jobs:
     timeout-minutes: 10
     name: "mkdocs"
     runs-on: ubuntu-latest
-    env:
-      MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
     steps:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
         with:
           fetch-depth: 0
           persist-credentials: false
       - uses: astral-sh/setup-uv@1e862dfacbd1d6d858c55d9b792c756523627244 # v7.1.4
       - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
-      - 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: "Build docs (public)"
-        run: uvx --with-requirements docs/requirements.txt mkdocs build --strict -f mkdocs.public.yml
 
-      - name: "Build docs (insiders)"
-        if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }}
-        run: uvx --with-requirements docs/requirements-insiders.txt mkdocs build --strict -f mkdocs.insiders.yml
+      - name: "Build docs"
+        run: uvx --with-requirements docs/requirements.txt mkdocs build --strict -f mkdocs.yml

.github/workflows/publish-docs.yml

@@ -23,8 +23,6 @@ permissions:
 jobs:
   mkdocs:
     runs-on: ubuntu-latest
-    env:
-      MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
     steps:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
         with:
@@ -62,27 +60,11 @@ 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 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: "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

CONTRIBUTING.md

@@ -104,22 +104,16 @@ git add ruff
 To preview any changes to the documentation locally 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
 [http://127.0.0.1:8000/ty/](http://127.0.0.1:8000/ty/).
 
-To update the documentation dependencies, edit `docs/requirements.in` and
-`docs/requirements-insiders.in`, then run:
+To update the documentation dependencies, edit `docs/requirements.in`, then run:
 
 ```shell
 uv pip compile docs/requirements.in -o docs/requirements.txt --universal -p 3.12
-uv pip compile docs/requirements-insiders.in -o docs/requirements-insiders.txt --universal -p 3.12
 ```
 
 Documentation is deployed automatically on release by publishing to the

docs/requirements.in

@@ -1,6 +1,6 @@
 black>=23.10.0
 mkdocs>=1.5.0
-mkdocs-material>=9.1.18
+mkdocs-material>=9.7.0
 mkdocs-redirects>=1.2.1
 mdformat>=0.7.17
 mdformat-mkdocs>=2.0.4

docs/requirements.txt

@@ -4,6 +4,8 @@ babel==2.15.0
     # via
     #   mkdocs-git-revision-date-localized-plugin
     #   mkdocs-material
+backrefs==6.1
+    # via mkdocs-material
 beautifulsoup4==4.13.4
     # via
     #   markdownify
@@ -94,7 +96,7 @@ mkdocs-git-revision-date-localized-plugin==1.3.0
     # via -r docs/requirements.in
 mkdocs-llmstxt==0.2.0
     # via -r docs/requirements.in
-mkdocs-material==9.5.29
+mkdocs-material==9.7.0
     # via -r docs/requirements.in
 mkdocs-material-extensions==1.3.1
     # via mkdocs-material
@@ -134,8 +136,6 @@ pyyaml==6.0.1
     #   pyyaml-env-tag
 pyyaml-env-tag==0.1
     # via mkdocs
-regex==2024.5.15
-    # via mkdocs-material
 requests==2.32.3
     # via mkdocs-material
 six==1.16.0

mkdocs.template.yml → mkdocs.yml

@@ -18,7 +18,6 @@ theme:
     - content.code.copy
     - content.tabs.link
   palette:
-    # Note: Using the system theme works with the insiders version
     # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
     - media: "(prefers-color-scheme)"
       toggle: