mirror of https://github.com/astral-sh/ruff
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:
parent
6f548d9872
commit
1a2e444799
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in New Issue