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

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

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

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 UCC: "index.md"
  - What's new: "whats_new.md"
  - Getting started: "quickstart.md"
  - Commands: "commands.md"
  - ".conf files": "dot_conf_files.md"
  - Generated files: "generated_files.md"
  - Inputs:
      - "inputs/index.md"
      - Introduction: "inputs/index.md"
      - Tabs: "inputs/tabs.md"
      - Multi-level menu: "inputs/multilevel_menu.md"
      - Helper module: "inputs/helper.md"
  - Options:
      - "options/index.md"
      - Rest Handlers: "options/rest_handlers.md"
  - Configuration:
      - "configurations/index.md"
      - Introduction: "configurations/index.md"
      - Logging: "configurations/logging.md"
      - Proxy: "configurations/proxy.md"
  - Dashboard: "dashboard.md"
  - Alert actions:
      - "alert_actions/index.md"
      - Alert action scripts: "alert_actions/alert_scripts.md"
      - Adaptive response: "alert_actions/adaptive_response.md"
  - Entity:
      - "entity/index.md"
      - Introduction: "entity/index.md"
      - Components: "entity/components.md"
      - Validators: "entity/validators.md"
      - Modify fields On change: "entity/modifyFieldsOnValue.md"
      - Help property: "entity/help_message.md"
      - User Playground: "entity/userPlayground.md"

  - Custom search commands: "custom_search_commands.md"
  - Table: "table.md"
  - Additional packaging: "additional_packaging.md"
  - OpenAPI: "openapi.md"
  - UCC-related libraries: "ucc_related_libraries.md"
  - Custom UI extensions:
      - Standard:
        - Overview: "custom_ui_extensions/standard/overview.md"
        - Custom hook: "custom_ui_extensions/standard/custom_hook.md"
        - Custom control: "custom_ui_extensions/standard/custom_control.md"
        - Custom row: "custom_ui_extensions/standard/custom_row.md"
        - Custom cell: "custom_ui_extensions/standard/custom_cell.md"
        - Custom tab: "custom_ui_extensions/standard/custom_tab.md"
      - Context:
        - Overview: "custom_ui_extensions/context/overview.md"
        - Initialize UI project : "custom_ui_extensions/context/custom_project_init.md"
        - Test UI project : "custom_ui_extensions/context/custom_test_ui_command.md"
        - Custom cell : "custom_ui_extensions/context/custom_cell_context.md"
        - Custom Tab : "custom_ui_extensions/context/custom_tab_context.md"
        - Custom Control : "custom_ui_extensions/context/custom_control_context.md"
        - Custom Hook : "custom_ui_extensions/context/custom_hook_context.md"
        - Custom Row : "custom_ui_extensions/context/custom_row_context.md"
  - Advanced:
      - Custom mapping: "advanced/custom_mapping.md"
      - Dependent dropdown: "advanced/dependent_dropdown.md"
      - OAuth support: "advanced/oauth_support.md"
      - Custom REST handler: "advanced/custom_rest_handler.md"
      - Groups feature: "advanced/groups_feature.md"
      - Save validator: "advanced/save_validator.md"
      - Requirements: "advanced/requirements.md"
      - OS-dependent libraries: "advanced/os-dependent_libraries.md"
      - Sub description: "advanced/sub_description.md"
      - Custom warning: "advanced/custom_warning.md"
  - Troubleshooting: "troubleshooting.md"
  - Contributing: "contributing.md"
  - Changelog: "CHANGELOG.md"
  - Metadata: "metadata.md"
  - Storybook: "storybook/index.html"
  - UI Tests:
      - Configuration Page:
          - General: "ui_tests_config_page_general.md"
          - Account: "ui_tests_config_page_account.md"
          - Custom: "ui_tests_config_page_custom.md"
          - Logging: "ui_tests_config_page_logging.md"
          - Proxy: "ui_tests_config_page_proxy.md"
      - Alert Action Page: "ui_tests_alert_actions_page.md"
      - Input Page: "ui_tests_inputs_page.md"