bitcaster-sdk/properdocs.yml at develop · bitcaster-io/bitcaster-sdk · 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
copyright: Copyright &copy; 2020-2024 OS4D ltd.
dev_addr: 127.0.0.1:8001
docs_dir: docs
edit_uri: 'blob/develop/docs/'
repo_url: https://github.com/bitcaster-io/bitcaster-sdk
site_author: Bitcaster Team
site_description: "Python SDK for the Bitcaster notification platform"
site_dir: ./~build/docs
site_name: Bitcaster SDK
site_url: https://bitcaster-io.github.io/bitcaster-sdk/
strict: false
extra_css:
  - _theme/css/style.css
exclude_docs: |
  ~*
  .m_templates
  .templates
  _scripts
  _guidelines


markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: '.'
      check_paths: true
  - tables
  - toc:
      permalink: #
      baselevel: 1


extra:
  generator: true
  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.

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bitcaster-io
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/bitcaster/bitcaster


theme:
  name: "material"
  color_mode: auto
  custom_dir: docs/_theme/overrides
  favicon: _theme/img/favicon.ico
  logo: _theme/img/logo.png
  user_color_mode_toggle: true
  features:
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: red
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: red
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-night
        name: Switch to light mode


plugins:
  - autorefs
  - awesome-pages
  - link-marker
  - macros
  - redirects:
      redirect_maps:
        'help/channel.md': 'glossary/terms/channel.md'
#        'some_file.md': 'http://external.url.com/foobar'
  - include-markdown:
      encoding: ascii
      preserve_includer_indent: false
      dedent: false
      trailing_newlines: true
      comments: false
      rewrite_relative_urls: true
      heading_offset: 0
      recursive: true
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
  - privacy
  - search
  - social
  - tags:
      tags_file: tags.md

watch:
  - docs/
  - src/

hooks:
  - docs/_hooks/hooks.py