cal-disp/mkdocs.yml at main · opera-adt/cal-disp · 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
site_name: Documentation for CAL-DISP
site_url: https://<your-username>.github.io/cal-disp/

# Theme
theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - search.suggest

# Navigation
nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Tutorials:
      - Download: tutorials/download.ipynb
      - Configuration: tutorials/config.ipynb
      - Product: tutorials/product.ipynb
  - API Reference: api.md

# Plugins
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            show_signature_annotations: true
            separate_signature: true
  - mkdocs-jupyter:
      include_source: true

# Markdown extensions
markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.snippets
  - toc:
      permalink: true