Use Insiders version of `mkdocs-material` (#5540)

## Summary

This PR migrates our `mkdocs-material` version to
[Insiders](https://squidfunk.github.io/mkdocs-material/insiders/), which
we can access now that we're sponsors.

We can't allow public access to the Insiders version, so we instead have
a private fork, which contains a deploy key that I've added as a
read-only Actions secret in this repo. (That is: the deploy key only
lets you read that one repo, and do nothing else.)

In general, non-Astral contributors can use the non-insiders version,
and everything is expected to "work", but without the insiders features
(they're intended to be ignored). See:
https://squidfunk.github.io/mkdocs-material/insiders/#compatibility.
This commit is contained in:
Charlie Marsh 2023-07-05 16:36:26 -04:00 committed by GitHub
parent 6f548d9872
commit 1a2e444799
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 6 deletions

View File

@ -255,11 +255,15 @@ jobs:
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- name: "Add SSH key"
uses: webfactory/ssh-agent@v0.7.0
with:
ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }}
- name: "Install Rust toolchain"
run: rustup show
- uses: Swatinem/rust-cache@v2
- name: "Install dependencies"
run: pip install -r docs/requirements.txt
run: pip install -r docs/requirements-insiders.txt
- name: "Update README File"
run: python scripts/transform_readme.py --target mkdocs
- name: "Generate docs"

View File

@ -13,12 +13,15 @@ jobs:
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- name: "Add SSH key"
uses: webfactory/ssh-agent@v0.7.0
with:
ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }}
- name: "Install Rust toolchain"
run: rustup show
- uses: Swatinem/rust-cache@v2
- name: "Install dependencies"
run: |
pip install -r docs/requirements.txt
run: pip install -r docs/requirements-insiders.txt
- name: "Copy README File"
run: |
python scripts/transform_readme.py --target mkdocs

View File

@ -0,0 +1,4 @@
PyYAML==6.0
black==23.3.0
mkdocs==1.4.3
git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git

View File

@ -1,4 +1,4 @@
mkdocs~=1.4.2
mkdocs-material~=9.0.6
PyYAML~=6.0
PyYAML==6.0
black==23.3.0
mkdocs==1.4.3
mkdocs-material==9.1.18