pydpc/mkdocs.yml at master · cwehmeyer/pydpc · 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
site_name: pydpc
site_description: Clustering by fast search and find of density peaks
site_url: https://cwehmeyer.github.io/pydpc/
repo_url: https://github.com/cwehmeyer/pydpc
repo_name: cwehmeyer/pydpc
edit_uri: edit/master/docs/

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
    - content.code.copy

nav:
  - Home: index.md
  - Tutorial: examples/Example01.ipynb
  - API Reference: reference.md
  - Changelog: changelog.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_root_heading: true
            show_source: false
            merge_init_into_class: true
            show_signature_annotations: true
  - mkdocs-jupyter:
      include: ["examples/*.ipynb"]
      execute: false
      include_source: true

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: ["."]