Skip to content

Commit df30765

Browse files
committed
chore(docs): upgrade MkDocs toolchain and drop temporary Pygments pin
The docs build was pinned to MkDocs and Material versions from early 2023. Upgrade them to current releases that still support Python 3.10, which Read the Docs uses: - mkdocs 1.4.2 -> 1.6.1 - mkdocs-material 9.0.5 -> 9.7.7 (9.8 requires Python >= 3.11) - mkdocs-material-extensions 1.1.1 -> 1.3.1 - mkdocs-include-markdown-plugin 6.0.6 -> 7.3.0 - mkdocs-glightbox 0.3.7 -> 0.5.3 Pygments 2.21.0 builds cleanly, so replace the temporary 2.19.2 pin with the current release. Also fix the palette config. In YAML, `primary: #3C64E2` is a comment, so primary and accent were null. Material 9.0 rendered that as "None" and the --md-primary-fg-color override in extra.css applied. Newer Material falls back to indigo, which overrides it. Use `custom`, the documented value for colours defined in CSS, so the header keeps the brand blue. Signed-off-by: mday-io <mdaytn@gmail.com>
1 parent c4dbac4 commit df30765

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎docs/requirements.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
mkdocs==1.4.2
2-
mkdocs-include-markdown-plugin==6.0.6
3-
mkdocs-material==9.0.5
4-
mkdocs-material-extensions==1.1.1
5-
mkdocs-glightbox==0.3.7
1+
mkdocs==1.6.1
2+
mkdocs-include-markdown-plugin==7.3.0
3+
mkdocs-material==9.7.7
4+
mkdocs-material-extensions==1.3.1
5+
mkdocs-glightbox==0.5.3
66
pdoc==14.5.1
7-
pygments==2.19.2 # Temporary pin: 2.20.0 breaks docs build; revisit after the fix
7+
pygments==2.21.0

‎mkdocs.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,16 +149,16 @@ theme:
149149
palette:
150150
- media: "(prefers-color-scheme: light)"
151151
scheme: default
152-
primary: #3C64E2
153-
accent: #3C64E2
152+
primary: custom
153+
accent: custom
154154
toggle:
155155
icon: material/weather-sunny
156156
name: Switch to dark mode
157157
# Palette toggle for dark mode
158158
- media: "(prefers-color-scheme: dark)"
159159
scheme: slate
160-
primary: #3C64E2
161-
accent: #3C64E2
160+
primary: custom
161+
accent: custom
162162
toggle:
163163
icon: material/weather-night
164164
name: Switch to light mode

0 commit comments

Comments
 (0)