pigwig/mkdocs.yml at main · raylu/pigwig · 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
site_name: pigwig
site_url: !ENV READTHEDOCS_CANONICAL_URL
repo_url: https://github.com/raylu/pigwig
edit_uri: edit/main/docs/
plugins:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          inventories: [https://docs.python.org/3/objects.inv]
          options:
            # https://mkdocstrings.github.io/python/usage/configuration/general/
            backlinks: tree
            # https://mkdocstrings.github.io/python/usage/configuration/headings/
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            type_parameter_headings: true
            # https://mkdocstrings.github.io/python/usage/configuration/members/
            filters: public
            inherited_members: true
            members_order: source
            # https://mkdocstrings.github.io/python/usage/configuration/docstrings/
            docstring_style: sphinx
            docstring_section_style: list
            merge_init_into_class: true
            scoped_crossrefs: true
            # https://mkdocstrings.github.io/python/usage/configuration/signatures
            annotations_path: source
            show_signature_annotations: true
            show_signature_type_parameters: true
            signature_crossrefs: true
  - privacy
  - search
  - social
nav:
  - home: index.md
  - pigwig.md
  - request_response.md
  - multipart.md
  - exceptions.md
theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      primary: deep purple
      toggle:
        icon: material/brightness-auto
        name: dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      toggle:
        icon: material/brightness-4
        name: light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      toggle:
        icon: material/brightness-7
        name: auto dark/light
  features:
    - search.suggest
markdown_extensions:
  - pymdownx.superfences
extra_css: [extra.css]
extra:
  generator: false
  social:
    - icon: fontawesome/brands/mastodon
      link: https://vmst.io/@raylu
      name: mastodon