CosmoTech-Acceleration-Library/mkdocs.yml at main · Cosmo-Tech/CosmoTech-Acceleration-Library · 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
site_name: Cosmotech Acceleration Library Docs
repo_url: https://github.com/Cosmo-Tech/CosmoTech-Acceleration-Library
repo_name: Cosmo-Tech/CosmoTech-Acceleration-Library
site_description: Acceleration library for CosmoTech cloud based solution development
site_url: https://cosmo-tech.github.io/CosmoTech-Acceleration-Library/

theme:
  name: material
  logo: assets/logo.png
  font:
    code: Fira Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.instant
    - navigation.footer
  custom_dir: docs/overrides
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css
  - stylesheets/templates.css

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascript/tablesort.js

extra:
  version:
    provider: mike
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      title: "In this page"
      permalink: true
  - def_list
  - mkdocs-click
  - pymdownx.details
  - pymdownx.snippets:
      url_download: true
  - pymdownx.betterem
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg


plugins:
  - search:
      lang:
        - en
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_inheritance_diagram: true
            show_source: false
            heading_level: 3
            show_root_heading: true
            show_root_toc_entry: false
            show_object_full_path: false
            show_symbol_type_toc: true
            members_order: alphabetical
            summary: true
            docstring_style: google
  - gen-files:
      scripts:
#        - docs/scripts/generate_references.py
        - docs/scripts/generate_dependencies_markdown.py
        - docs/scripts/generate_index.py
        - docs/scripts/generate_command_helps.py
  - mike
  - social
  - table-reader
  - awesome-nav
  - literate-nav