Skip to content

Commit ac54f26

Browse files
committed
build(mkdocs): improve configuration and fix paths
- Fix trailing slashes in custom_dir and modules paths for consistency - Enable caching for include-markdown plugin to improve build performance - Adjust watch list formatting and remove unnecessary entries - Update comment style for better template rendering These changes ensure proper path resolution and improve build performance while maintaining consistent configuration formatting.
1 parent 215a2c2 commit ac54f26

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

template/.config/copier/mkdocs.yaml.jinja

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# -*- mode: yaml; -*-
1+
# {#- -*- mode: yaml; -*- -#}
22
# This file is @generated by <https://github.com/liblaf/copier-python>.
33
# DO NOT EDIT!
44

@@ -27,7 +27,7 @@ extra_javascript:
2727

2828
theme:
2929
name: material
30-
custom_dir: docs/overrides/
30+
custom_dir: docs/overrides
3131
features:
3232
# - announce.dismiss
3333
- content.action.edit
@@ -106,6 +106,7 @@ plugins:
106106

107107
# ----------- External plugins, schema provided by our community ----------- #
108108
include-markdown:
109+
cache: 600
109110
git-revision-date-localized:
110111
enable_creation_date: true
111112
mkdocstrings:
@@ -212,7 +213,7 @@ plugins:
212213

213214
api-autonav: # ref: <https://github.com/tlambert03/mkdocs-api-autonav>
214215
modules:
215-
- "src/{{ wheel_package_dir }}/"
216+
- "src/{{ wheel_package_dir }}"
216217

217218
# hippogriffe: # ref: <https://github.com/patrick-kidger/hippogriffe>
218219
# hippogriffe requires `mkdocstrings.python.options.force_inspection: true`. (This is so it can do things like display type annotations correctly.)
@@ -256,7 +257,6 @@ markdown_extensions:
256257
mdx_truly_sane_lists:
257258

258259
watch:
259-
- .config/copier/mkdocs.yaml
260-
- docs/
260+
- docs
261261
- README.md
262-
- src/
262+
- src

0 commit comments

Comments
 (0)