docvet/mkdocs.yml at main · Alberto-Codes/docvet · 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
site_name: docvet
site_description: Comprehensive docstring quality vetting for Python projects
site_url: https://alberto-codes.github.io/docvet/
repo_url: https://github.com/Alberto-Codes/docvet
repo_name: Alberto-Codes/docvet
copyright: "Copyright &copy; 2026 Alberto-Codes &mdash; MIT License"

docs_dir: docs/site

theme:
  name: material
  palette:
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.svg
  logo: assets/logo.svg
  icon:
    annotation: material/chevron-right-circle
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.footer
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tooltips

extra_css:
  - stylesheets/theme.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Alberto-Codes/docvet
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/docvet/

plugins:
  - search
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: google
            show_root_heading: true
            show_root_full_path: false
            # Signatures
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            modernize_annotations: true
            line_length: 88
            # Headings
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            # Members
            members_order: source
            show_category_heading: true
            # Docstrings
            merge_init_into_class: true
            docstring_section_style: table
            docstring_options:
              ignore_init_summary: true
  - macros:
      module_name: docs/main

nav:
  - Getting Started: index.md
  - Concepts: concepts.md
  - CI Integration: ci-integration.md
  - Editor Integration: editor-integration.md
  - AI Agent Integration: ai-integration.md
  - Checks:
    - checks/presence.md
    - checks/enrichment.md
    - checks/freshness.md
    - checks/coverage.md
    - checks/griffe.md
  - Rules:
    - Presence:
      - missing-docstring: rules/missing-docstring.md
      - overload-has-docstring: rules/overload-has-docstring.md
    - Enrichment:
      - missing-raises: rules/missing-raises.md
      - missing-returns: rules/missing-returns.md
      - missing-return-type: rules/missing-return-type.md
      - missing-yields: rules/missing-yields.md
      - missing-receives: rules/missing-receives.md
      - missing-warns: rules/missing-warns.md
      - missing-other-parameters: rules/missing-other-parameters.md
      - missing-attributes: rules/missing-attributes.md
      - missing-typed-attributes: rules/missing-typed-attributes.md
      - missing-examples: rules/missing-examples.md
      - missing-cross-references: rules/missing-cross-references.md
      - missing-param-in-docstring: rules/missing-param-in-docstring.md
      - extra-param-in-docstring: rules/extra-param-in-docstring.md
      - missing-deprecation: rules/missing-deprecation.md
      - extra-raises-in-docstring: rules/extra-raises-in-docstring.md
      - extra-yields-in-docstring: rules/extra-yields-in-docstring.md
      - extra-returns-in-docstring: rules/extra-returns-in-docstring.md
      - trivial-docstring: rules/trivial-docstring.md
      - undocumented-init-params: rules/undocumented-init-params.md
      - prefer-fenced-code-blocks: rules/prefer-fenced-code-blocks.md
      - scaffold-incomplete: rules/scaffold-incomplete.md
    - Freshness:
      - stale-signature: rules/stale-signature.md
      - stale-body: rules/stale-body.md
      - stale-import: rules/stale-import.md
      - stale-drift: rules/stale-drift.md
      - stale-age: rules/stale-age.md
    - Coverage:
      - missing-init: rules/missing-init.md
    - Griffe:
      - griffe-unknown-param: rules/griffe-unknown-param.md
      - griffe-missing-type: rules/griffe-missing-type.md
      - griffe-format-warning: rules/griffe-format-warning.md
  - Configuration: configuration.md
  - Inline Suppression: suppression.md
  - Architecture: architecture.md
  - CLI Reference: cli-reference.md
  - Glossary: glossary.md
  - Privacy Policy: privacy.md
  - License: license.md
  - Reference: reference/

markdown_extensions:
  - abbr
  - def_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - toc:
      permalink: true