pytest-robotframework/mkdocs.yml at master · DetachHead/pytest-robotframework · 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
site_name: pytest-robotframework
site_url: https://detachhead.github.io/pytest-robotframework
theme:
  name: material
  features:
    - navigation.indexes
    - content.code.copy
    - navigation.top
    - navigation.instant
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: teal
      accent: teal
      scheme: default

      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: teal
      accent: teal
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  favicon: img/favicon.ico
  icon:
    repo: fontawesome/brands/github
markdown_extensions:
  - pymdownx.magiclink
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.escapeall:
      hardbreak: true
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
plugins:
  - search
  # https://github.com/wilhelmer/mkdocs-unused-files/issues/12
  # - unused_files
  - awesome-pages
  - mkdocstrings:
      handlers:
        python:
          options:
            extensions:
              - griffe_public_redundant_aliases
            docstring_style: sphinx
            show_if_no_docstring: true
            show_signature_annotations: true
            show_labels: false
            filters:
              - "!^_"
              - "__init__"
              - "__new__"

nav:
  - index.md
  - installation.md
  - features.md
  - ...
  - ... | development/**/*.md
repo_url: https://github.com/detachhead/pytest-robotframework
repo_name: detachhead/pytest-robotframework
extra_css:
  - stylesheets/extra.css
validation:
  nav:
    # using awesome-pages plugin so it doesn't recognize these:
    omitted_files: info
    absolute_links: info
  links:
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/detachhead/pytest-robotframework
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pytest-robotframework/