Skip to content

Commit 0e0e619

Browse files
committed
fix: pin mkdocs<2.0 and mkdocs-material<10, add NO_MKDOCS_2_WARNING to all CI doc steps
1 parent 07f9737 commit 0e0e619

4 files changed

Lines changed: 10 additions & 2 deletions

File tree

.github/workflows/docs-update.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,8 @@ jobs:
8686
ID: ${{ steps.get-user-id.outputs.user-id }}
8787
- name: Create release
8888
shell: bash
89+
env:
90+
NO_MKDOCS_2_WARNING: '1'
8991
run: |
9092
mike deploy --push ${{ needs.mike-version.outputs.mver }}
9193
- name: Ensure latest is latest

.github/workflows/python-push.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ jobs:
101101
make docs-ubuntu-deps
102102
- name: Validate website content (mkdocs)
103103
if: steps.core-version.outputs.core == 'true'
104+
env:
105+
NO_MKDOCS_2_WARNING: '1'
104106
run: |
105107
make docs-validate
106108
- name: Pytest Fast

.github/workflows/python-test.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,13 @@ jobs:
6767
run: |
6868
make docs-ubuntu-deps
6969
- name: Validate website content (mkdocs)
70+
env:
71+
NO_MKDOCS_2_WARNING: '1'
7072
run: |
7173
make docs-validate
7274
- name: Check if dirty (mkdocs)
75+
env:
76+
NO_MKDOCS_2_WARNING: '1'
7377
run: |
7478
make check-for-changes
7579

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@ typing = [
6464
# Documentation website
6565
docs = [
6666
"mike",
67-
"mkdocs>=1.6.0",
67+
"mkdocs>=1.6.0,<2.0.0",
6868
"mkdocs-awesome-pages-plugin",
6969
"mkdocstrings[python]>=0.25.2",
7070
"mkdocs-htmlproofer-plugin",
71-
"mkdocs-material",
71+
"mkdocs-material>=9.0.0,<10.0.0",
7272
"markdown-include",
7373
"mkdocs-minify-plugin",
7474
"mkdocs-git-revision-date-localized-plugin",

0 commit comments

Comments
 (0)