pygraphics/mkdocs.yml at main · PyDevices/pygraphics · 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
site_name: pygraphics
site_url: https://pygraphics.readthedocs.io
repo_url: https://github.com/PyDevices/pygraphics/
edit_uri: edit/main/docs/
copyright: "Copyright 2024–2026, Brad Barnett & PyDevices Contributors"
docs_dir: docs
site_dir: site
strict: true

# docs/README.md is the curated GitHub-browsing index for the docs/ folder
# (see repo convention: every docs/ directory has a README.md). It duplicates
# docs/index.md, which is the MkDocs site landing page, so exclude it from
# the built site to resolve the index.md/README.md conflict.
exclude_docs: |
  README.md

theme:
  name: material
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tabs.link

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables

extra_javascript:
  - assets/pyscript/pydevices-runner.js

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/PyDevices/pygraphics
    - icon: fontawesome/brands/python
      link: https://test.pypi.org/project/pydevices-pygraphics/
    - icon: fontawesome/solid/globe
      link: https://pydevices.github.io

plugins:
  - search
  - gen-files:
      scripts:
        - scripts/mkdocs_gen_ref_pages.py
  - literate-nav:
      nav_file: summary.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [lib]
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
            docstring_options:
              # Convention (see dotgithub/docs/docstrings.md) documents bare
              # `Returns:\n    Area: description` — a type, not a name. Griffe's
              # default (returns_named_value: true) requires the type in
              # parens (`(Area): description`) and otherwise treats a bare
              # leading word as the return *name*, which is a false-positive
              # "no type" warning under --strict. This option makes the bare
              # `type: description` form the expected one, matching our style.
              returns_named_value: false
            merge_init_into_class: true
            filters:
              - "!^_"