template-python/mkdocs.yml at main · markurtz/template-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
---
site_name: "template-python"
site_description: "An opinionated, production-ready Apache 2.0 template repository for bootstrapping\
  \ modern software projects."
site_author: "markurtz"
site_url: "https://markurtz.github.io/template-python/"
repo_url: "https://github.com/markurtz/template-python"
repo_name: "markurtz/template-python"
edit_uri: edit/main/docs/
extra:
  version:
    provider: mike
  project_name: "template_python"
  project_description: "An opinionated, production-ready Apache 2.0 template repository for\
    \ bootstrapping modern software projects."
  org_name: "markurtz"
#  org_email: "conduct@example.com"
  docs_url: "https://markurtz.github.io/template-python"
  min_python: "3.9"
  current_major_version: "0"
#  slack_url: "https://slack.example.com"
#  blog_url: "https://blog.example.com"
  roadmap_url: "https://github.com/markurtz/template-python/milestones"
theme:
  name: material
  logo: assets/branding/icon-white.svg
  favicon: assets/branding/icon-black.svg
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.action.edit
    - content.tabs.link
    - content.tooltips
    - toc.follow
    - toc.integrate
    - header.autohide
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - "."
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - toc:
      permalink: true
plugins:
  - gen-files:
      scripts:
        - docs/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - macros
  - mike
  - minify:
      minify_html: true
  - mkdocs-nav-weight
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: sphinx
  - search
  - section-index
  - tags
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - scripts/extra.js
# ---------------------------------------------------------------------------
# LLM & AI Tooling
# ---------------------------------------------------------------------------
# llms.txt (root-level file) is served at /llms.txt on the deployed docs site.
# It follows the llmstxt.org specification and provides a curated, machine-
# readable index of documentation for LLM consumers and AI coding agents.
# A companion file, llms-full.txt, contains the concatenated documentation.
# The root AGENTS.md contains agent-specific coding instructions; it is also
# surfaced in the docs nav under Community > AI Agent Guide.
# ---------------------------------------------------------------------------
validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    absolute_links: warn
    unrecognized_links: warn