docopt2/mkdocs.yml at main · Solganis/docopt2 · 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
site_name: docopt2
site_description: "Typed successor to docopt: the usage message is the parser spec."
site_url: https://solganis.github.io/docopt2/
repo_url: https://github.com/Solganis/docopt2
repo_name: Solganis/docopt2
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2026 Solganis and docopt2 contributors

# A link to a heading that does not exist is INFO by default, so `--strict` lets it through and the dead
# anchor ships. These are the classes of broken link worth failing the build over.
validation:
  links:
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn
  nav:
    omitted_files: warn
    not_found: warn

theme:
  name: material
  logo: assets/logo-dark.png
  favicon: assets/logo.png
  font:
    text: Source Serif 4
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
    - toc.follow

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          # src layout: point griffe at src/ so it resolves docopt2 without an install step.
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: table
            filters: ["!^_"]
            heading_level: 2
            members_order: source
            merge_init_into_class: true
            overloads_only: true
            separate_signature: true
            show_bases: false
            show_root_heading: false
            show_root_full_path: false
            show_root_toc_entry: false
            show_signature_annotations: true
            show_source: true
            show_symbol_type_heading: false
            show_symbol_type_toc: false
            signature_crossrefs: false

extra_css:
  - stylesheets/extra.css

# Rebuild the live `mkdocs serve` site when docstrings in the package change,
# not just when files under docs/ change.
watch:
  - src/docopt2

nav:
  - Introduction: index.md
  - Getting started: getting-started.md
  # Three groups, and the third is not a taste call: it is exactly the `docopt2` CLI subcommands, a
  # boundary the product already draws. The usage DSL leads, because every other page derives from it.
  - Guides:
      - The usage message:
          - Usage DSL: guides/usage-dsl.md
          - Diagnostics: guides/diagnostics.md
          - Rich help: guides/help.md
      - Parsing into your program:
          - Typed results: guides/typed-results.md
          - Subcommand dispatch: guides/dispatch.md
          - Shell completion: guides/completion.md
          - Round-trip to argv: guides/round-trip.md
      - The docopt2 command:
          - Schema stubs: guides/stub.md
          - Usage linting: guides/check.md
          - Formatting usage: guides/fmt.md
          - Compatibility checking: guides/compat.md
          - Example generation: guides/examples.md
  - Concepts:
      - Design boundaries: concepts/design-boundaries.md
  - API Reference:
      - Overview: reference/overview.md
      - docopt & results: reference/docopt.md
      - Cli base class: reference/cli.md
      - Subcommand dispatch: reference/dispatch.md
      - Schema stubs: reference/stub.md
      - Usage linting: reference/check.md
      - Formatting usage: reference/fmt.md
      - Compatibility checking: reference/compat.md
      - Example generation: reference/examples.md
      - Config templates: reference/config-templates.md
      - Shell completion: reference/completion.md
      - Exceptions: reference/exceptions.md
      - Usage grammar: reference/grammar.md