DaskGenie/mkdocs.yml at main · polymood/DaskGenie · 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
site_name: DaskGenie
site_description: A memory profiler and live dashboard for Dask that ties a worker's memory back to the line of your code that caused it.
site_url: https://polymood.github.io/DaskGenie/
repo_url: https://github.com/polymood/DaskGenie
repo_name: polymood/DaskGenie
edit_uri: edit/develop/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - toc.follow

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            docstring_style: google
            separate_signature: true
            show_root_heading: true

nav:
  - Home: index.md
  - Installation: installation.md
  - Quick start: quickstart.md
  - The dashboard: dashboard.md
  - Deep memory: deep-memory.md
  - Local schedulers: local-schedulers.md
  - Configuration: configuration.md
  - Examples: examples.md
  - API reference: api.md
  - Contributing: contributing.md
  - Changelog: changelog.md