python-devops/mkdocs.yml at stable · ibm-mas/python-devops · 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
site_name: MAS DevOps Documentation
site_description: Python library for Maximo Application Suite Dev/Ops
site_author: IBM Maximo Team
site_url: https://ibm-mas.github.io/python-devops/

repo_name: ibm-mas/python-devops
repo_url: https://github.com/ibm-mas/python-devops
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            group_by_category: true
            show_category_heading: true
            show_if_no_docstring: false
            inherited_members: false
            filters:
              - "!^_"

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - API Reference:
    - Overview: api/index.md
    - Core Modules:
      - OCP: api/ocp.md
      - Tekton: api/tekton.md
      - OLM: api/olm.md
      - Utils: api/utils.md
    - MAS Modules:
      - Suite: api/mas/suite.md
      - Apps: api/mas/apps.md
    - Services:
      - DB2: api/db2.md
      - SLS: api/sls.md
      - AI Service: api/aiservice.md
      - Slack: api/slack.md
    - SaaS:
      - Job Cleaner: api/saas/job_cleaner.md
    - Users: api/users.md
  - CLI Tools:
    - Overview: cli/index.md
    - DB2 Validate Config: cli/db2-validate-config.md
    - Create Initial Users: cli/create-initial-users.md
    - SaaS Job Cleaner: cli/saas-job-cleaner.md
    - Notify Slack: cli/notify-slack.md
  - Contributing: contributing.md
  - License: license.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ibm-mas/python-devops