diff --git a/mkdocs.yml b/mkdocs.yml index 724b8f617..03a8c7069 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,33 +37,39 @@ plugins: options: # General allow_inspection: true + extensions: + - dataclasses + - griffe_generics + # - griffe_inherited_method_crossrefs # Waiting on upstream fix + - griffe_pydantic + - griffe_warnings_deprecated + show_inheritance_diagram: true show_source: true - show_bases: true # Headings heading_level: 2 - show_root_heading: false - show_root_toc_entry: true - show_root_full_path: true - show_root_members_full_path: false - show_object_full_path: false show_category_heading: true + show_symbol_type_heading: true + show_symbol_type_toc: true # Members filters: - '!^_' - '!^__' - group_by_category: true - show_submodules: false # Docstrings docstring_style: google docstring_options: ignore_init_summary: true docstring_section_style: spacy merge_init_into_class: true + relative_crossrefs: true + scoped_crossrefs: true show_if_no_docstring: true # Signature annotations_path: brief - show_signature: true + modernize_annotations: true + overloads_only: true show_signature_annotations: true + show_signature_type_parameters: true + signature_crossrefs: true - llmstxt: full_output: llms-full.txt sections: @@ -120,7 +126,7 @@ markdown_extensions: custom_checkbox: true - pymdownx.tilde -copyright: Copyright © 2023 Pact Foundation +copyright: Copyright © 2025 Pact Foundation theme: name: material @@ -133,7 +139,9 @@ theme: - content.action.view - content.code.annotate - content.code.copy + - content.code.select - content.tooltips + - content.tabs.link - navigation.indexes - navigation.instant - navigation.instant.progress diff --git a/pyproject.toml b/pyproject.toml index ffc7b934f..25503133b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -82,15 +82,19 @@ dev = [ ] docs = [ - "mkdocs-github-admonitions-plugin~=0.0", - "mkdocs-literate-nav~=0.6", - "mkdocs-llmstxt~=0.3", - "mkdocs-material[recommended,git,imaging]~=9.0", - "mkdocs-section-index~=0.3", - "mkdocs_gen_files~=0.5", - "mkdocstrings[python]~=0.23", - "mkdocs~=1.5", - "pathspec~=0.0", + "griffe-generics==1.0.13", + "griffe-inherited-method-crossrefs==0.0.1.4", + "griffe-pydantic==1.1.7", + "griffe-warnings-deprecated==1.1.0", + "mkdocs-gen-files==0.5.0", + "mkdocs-github-admonitions-plugin==0.1.1", + "mkdocs-literate-nav==0.6.2", + "mkdocs-llmstxt==0.4.0", + "mkdocs-material[recommended,git,imaging]==9.6.21", + "mkdocs-section-index==0.3.10", + "mkdocs==1.6.1", + "mkdocstrings[python]==0.30.1", + "pathspec==0.12.1", ] example = [ "fastapi~=0.0",