magicbell-python-sdk/mkdocs.yml at main · MSeal/magicbell-python-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
# general mkdocs config
site_name: MagicBell Python SDK
nav:
  - Home: index.md
  - Examples:
      - 'Setup': examples/index.md
      - 'Getting Started': examples/01 - Getting Started.ipynb
      - 'Users': examples/02 - Users.ipynb
      - 'Projects': examples/03 - Projects.ipynb
      - 'GraphQL': examples/04 - GraphQL.ipynb
  - Reference:
      - 'MagicBell': reference/magicbell-client.md
      - 'Configuration': reference/configuration.md
      - 'RealtimeAPI': reference/realtime-api.md
      - 'UserAPI': reference/user-api.md
      - 'ProjectAPI': reference/project-api.md
      - 'GraphQLAPI': reference/graphql-api.md
repo_url: https://github.com/noteable-io/magicbell-python-sdk
repo_name: noteable-io/magicbell-python-sdk
edit_uri: edit/main/docs/

# Material theme config
theme:
  name: material
  custom_dir: overrides
  palette:
    scheme: slate
  features:
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
    - navigation.instant


# plugins
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: 'numpy'
  - mkdocs-jupyter:
      include_source: True

markdown_extensions:
  # code highlighting
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/noteable_io
    - icon: fontawesome/brands/github
      link: https://github.com/noteable-io
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/noteable-io/
    - icon: fontawesome/brands/medium
      link: https://medium.com/noteableio