pact-python/mkdocs.yml at main · adityagiri3600/pact-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
---
site_name: Pact Python
site_url: https://pact-foundation.github.io/pact-python/

repo_name: pact-foundation/pact-python
repo_url: https://github.com/pact-foundation/pact-python

edit_uri: edit/develop/docs

hooks:
  - docs/scripts/rewrite-docs-links.py

plugins:
  - gen-files:
      scripts:
        - docs/scripts/markdown.py
        - docs/scripts/python.py
        # - docs/scripts/other.py
  - search
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - gh-admonitions
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          inventories:
            - https://docs.aiohttp.org/en/stable/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://docs.python.org/3/objects.inv
            - https://fastapi.tiangolo.com/objects.inv
            - https://flask.palletsprojects.com/en/stable/objects.inv
            - https://googleapis.dev/python/protobuf/latest/objects.inv
            - https://grpc.github.io/grpc/python/objects.inv
            - https://requests.readthedocs.io/en/latest/objects.inv
          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
            # Headings
            heading_level: 2
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            # Members
            filters:
              - '!^_'
              - '!^__'
            # 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
            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:
        Usage documentation:
          - api/*.md
          - api/**/*.md
        Examples:
          - examples/*.md
  - social
  - blog:
      blog_toc: true
      post_excerpt: required

markdown_extensions:
  # Python Markdown
  - abbr
  - attr_list
  - footnotes
  - meta
  - md_in_html
  - tables
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.blocks.admonition
  - pymdownx.blocks.definition
  - pymdownx.blocks.details
  - pymdownx.blocks.html:
  - pymdownx.blocks.tab:
      alternate_style: true
  - pymdownx.caret
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.pathconverter:
      absolute: false
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

copyright: Copyright &copy; 2025 Pact Foundation

theme:
  name: material

  icon:
    repo: fontawesome/brands/github

  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tooltips
    - content.tabs.link
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  palette:
    - media: (prefers-color-scheme)
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: cyan
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: cyan
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to system preference

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pact-foundation/pact-python