Skip to content

Commit 2f8f2b7

Browse files
committed
feat(docs): improve mkdocstrings configuration
Enhance Python documentation generation with updated mkdocstrings settings. This commit: - Enables `dataclasses`, `unpack_typeddict`, and `griffe_fieldz` extensions for richer API documentation. - Sets member filters to `public` for clearer visibility of exposed APIs. - Introduces `overloads_only`, `show_signature_type_parameters`, `parameter_headings`, and `type_parameter_headings` for more precise and structured signature and parameter display. - Removes the `docstring_inheritance.griffe` extension due to a reported crash. - Activates `skip_local_inventory` for potential build performance improvements.
1 parent 64558e4 commit 2f8f2b7

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -165,30 +165,33 @@ plugins:
165165
# General
166166
backlinks: tree
167167
extensions:
168-
# Official extensions
168+
# Built-in
169+
- dataclasses
170+
- unpack_typeddict
171+
# Official
169172
- griffe_inherited_docstrings
170173
- griffe_pydantic:
171174
schema: true
172175
- griffe_warnings_deprecated
173176
# Third-party extensions
174-
- docstring_inheritance.griffe
177+
# - docstring_inheritance.griffe # crash
175178
- griffe_fieldz:
176179
include_inherited: true
177180
# - griffe_generics # crash
178181
# - griffe_inherited_method_crossrefs # does not work
179182
find_stubs_package: true
180183
show_inheritance_diagram: true
184+
skip_local_inventory: true
181185
# Headings
182186
heading_level: 1
187+
parameter_headings: true
183188
show_root_heading: true
184189
show_symbol_type_heading: true
185190
show_symbol_type_toc: true
191+
type_parameter_headings: true
186192
# Members
187193
inherited_members: true
188-
filters:
189-
- "!__all__"
190-
- "!^_[^_]"
191-
- "!^_$"
194+
filters: public
192195
summary: true
193196
# Docstrings
194197
docstring_style: google
@@ -201,9 +204,10 @@ plugins:
201204
show_if_no_docstring: true
202205
# Signatures
203206
modernize_annotations: true
207+
overloads_only: true
204208
show_signature_annotations: true
209+
show_signature_type_parameters: true
205210
separate_signature: true
206-
show_overloads: true
207211
signature_crossrefs: true
208212

209213
# ---------------------------- External Plugins ---------------------------- #

0 commit comments

Comments
 (0)