mkdocs-experiments-fork/mkdocs.yml at main · Mko13/mkdocs-experiments-fork · 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
155
156
157
158
159
160
161
162
163
164
165
166
167
site_name: Robot Framework Manual
site_description: Robot Framework is a generic open source automation framework.
site_url: https://pekkaklarck.github.io/mkdocs-experiments/  # mike needs `/`.
repo_url: https://github.com/robotframework/robotframework
edit_uri: https://github.com/pekkaklarck/mkdocs-experiments/blob/main/docs
copyright: |
  &copy; 2024- <a href="https://robotframework.org/foundation" target="_blank" rel="noopener">Robot Framework Foundation</a>
watch:
  - src/robot/
  - overrides

nav:
  - Welcome: index.md
  - Using:
    - using/index.md
    - Input data: using/data.md
    - Executing tests and tasks: using/execution.md
  - Standard libraries:
      - libraries/index.md
  - Extending:
    - extending/index.md
    - Creating libraries: extending/libraries.md
  - API: api/    # API navigation is generated by docs/api/generate.py
  - Glossary: glossary.md

extra_css:
  - styles/extra.css

extra_javascript:
  - styles/extra.js

theme:
  name: material
  logo: styles/logo-white.png
  favicon: styles/logo.png
  icon:
    repo: fontawesome/brands/github
  custom_dir: overrides
  features:
    - announce.dismiss
    - navigation.tabs
    - navigation.sections
    - navigation.footer
    - navigation.top
    - navigation.indexes
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
  language: en
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: custom
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: custom
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: custom
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - search
  - social:
      cards_layout_options:
        background_color: "#00c0b5"
  - autorefs
  - exclude:
      glob:
        - api/generate.py
  - gen-files:
      scripts:
        - docs/api/generate.py
  - literate-nav:
      nav_file: nav.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            inherited_members: true
            members_order: source
            group_by_category: false
            show_root_heading: true
            merge_init_into_class: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
  - mike:
      canonical_version: latest
  - ezglossary:
      use_default: true
      ignore_case: true
      plurals: en
      tooltip: full
      inline_refs: list

hooks:
  - hooks/test_or_task.py

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/robotframework/
    - icon: fontawesome/brands/slack
      link: https://slack.robotframework.org
    - icon: fontawesome/brands/discourse
      link: https://forum.robotframework.org
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/robot-framework-foundation
  version:
    provider: mike
    alias: true

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - toc:
      permalink: true
  # PyMdown Extensions we use (there are more)
  # https://facelessuser.github.io/pymdown-extensions/
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.highlight:
      default_lang: python
      linenums: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      user: robotframework
      repo: robotframework
  - pymdownx.saneheaders
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true