Skip to content

Commit a417289

Browse files
committed
docs: update mkdocs configuration
- Add trailing comma in site URL configuration - Specify custom theme directory for overrides - Enhance pydantic and fieldz documentation settings with schema and inherited member support
1 parent a4da60d commit a417289

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ site_url:
77
!ENV [
88
READTHEDOCS_CANONICAL_URL,
99
SITE_URL,
10-
"https://{{ github_user }}.github.io/{{ github_repo }}/"
10+
"https://{{ github_user }}.github.io/{{ github_repo }}/",
1111
]
1212
site_author: "{{ author_name }}"
1313
repo_name: "{{ github_user }}/{{ github_repo }}"
@@ -27,6 +27,7 @@ extra_javascript:
2727

2828
theme:
2929
name: material
30+
custom_dir: docs/overrides/
3031
features:
3132
# - announce.dismiss
3233
- content.action.edit
@@ -116,11 +117,13 @@ plugins:
116117
extensions:
117118
# Official extensions
118119
- griffe_inherited_docstrings
119-
- griffe_pydantic
120+
- griffe_pydantic:
121+
schema: true
120122
- griffe_warnings_deprecated
121123
# Third-party extensions
122124
- docstring_inheritance.griffe
123-
- griffe_fieldz
125+
- griffe_fieldz:
126+
include_inherited: true
124127
- griffe_generics
125128
# - griffe_inherited_method_crossrefs # does not work
126129
find_stubs_package: true

0 commit comments

Comments
 (0)