addonfactory-ucc-test/mkdocs.yml at develop · splunk/addonfactory-ucc-test · 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
site_name: AUT Framework
site_author: Splunk
site_url: "https://splunk.github.io/addonfactory-ucc-test/"
edit_uri: "tree/main/docs/"
remote_branch: gh-pages

repo_name: Splunk Add-on AUT Framework
repo_url: "https://github.com/splunk/addonfactory-ucc-test"

markdown_extensions:
  - toc:
      permalink: True
  - smarty
  - fenced_code
  - sane_lists
  - codehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - footnotes
  - pymdownx.tasklist

theme:
  name: "material"
  custom_dir: docs/theme_overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.indexes

extra_css:
  - css/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_if_no_docstring: true
            filters: ["!^_"]
            show_source: true
  - autorefs
  - print-site  # should be at the end

nav:
  - About AUT: "index.md"
  - Hello World: "hello_world.md"
  - Design Principles: "design_principles.md"
  - Test Scenarios: "test_scenarios.md"
  - Before you write your first line of code: "before_you_write_your_first_line_of_code.md"
  - When you write your tests: "when_you_write_your_tests.md"
  - ucc-test-modinput CLI tool: "ucc-test-modinput_cli_tool.md"
  - addonfactory-ucc-test pytest plugin: "addonfactory-ucc-test_pytest_plugin.md"
  - Contributing: "contributing.md"
  - Changelog: "CHANGELOG.md"
  - Troubleshooting: "troubleshooting.md"
  - Framework deepdive: "framework_deepdive.md"