Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: try mike 2.1.0 beta #43

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
on:
push:
branches: [main]
workflow_dispatch:
inputs:
ref:
Expand Down Expand Up @@ -46,6 +45,7 @@ jobs:
id: setup-pdm
with:
python-version: ${{ matrix.python-version }}
pdm-version: "2.12.4"
cache: true
allow-python-prereleases: true

Expand All @@ -58,12 +58,6 @@ jobs:
# If pull request or not main branch and not a tag
if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main' && !startsWith(github.ref, 'refs/tags/')) || github.event_name == 'workflow_dispatch'

- name: Patch mike 2.0.0
run: |
# In .venv/lib/python3.11/site-packages/mike/mkdocs_utils.py, replace `config = mkdocs.utils.yaml_load(f)` by `config = mkdocs.config.load_config(f).data`
# Issue: https://github.com/jimporter/mike/issues/199
sed -i 's/config = mkdocs.utils.yaml_load(f)/config = mkdocs.config.load_config(f).data/' .venv/lib/python3.11/site-packages/mike/mkdocs_utils.py

- name: Configure git
run: |
git config user.email "[email protected]"
Expand Down
10 changes: 4 additions & 6 deletions pdm.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ docs = [
"mkdocs-include-markdown-plugin>=6.0.4",
"mkdocstrings[python]>=0.24.0",
"mdx-truly-sane-lists>=1.3",
"mike>=2.0.0",
"mike @ git+https://github.com/jimporter/mike",
"markdown-exec>=1.7",
"mkdocs-git-authors-plugin>=0.7.2",
"mkdocs-git-revision-date-localized-plugin>=1.2.2",
Expand Down
Loading