httpkom/mkdocs.yml at master · osks/httpkom · 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
dev_addr: localhost:8001

site_name: httpkom
site_description: REST-like HTTP API for LysKOM
site_url: https://github.com/osks/httpkom

repo_url: https://github.com/osks/httpkom
repo_name: osks/httpkom

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.sections
    - navigation.expand
    - search.highlight

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            members_order: source
            heading_level: 3

nav:
  - Introduction: index.md
  - API Reference:
    - Sessions: sessions.md
    - Conferences: conferences.md
    - Texts: texts.md
    - Persons: persons.md
    - Memberships: memberships.md
    - Server: server.md
    - WebSocket: websocket.md

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.details
  - toc:
      permalink: true