dygraphs/mkdocs.yml at main · saemeon/dygraphs · 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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site_name: dygraphs
site_description: Python wrapper for the dygraphs JavaScript charting library — ported from R dygraphs with adapters for Dash and Shiny
site_author: Simon Niederberger
site_url: https://saemeon.github.io/dygraphs/

repo_url: https://github.com/saemeon/dygraphs
repo_name: saemeon/dygraphs

copyright: "Copyright &copy; 2026 Simon Niederberger"

nav:
  - Home: "index.md"
  - API Reference: "api.md"

theme:
  name: material
  features:
    - content.width.wide
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.top
    - navigation.tracking
    - content.action.edit
    - search.highlight
    - search.suggest
  icon:
    repo: fontawesome/brands/github
    edit: material/eye
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            docstring_section_style: spacy
            show_if_no_docstring: False
            show_root_toc_entry: False
            show_source: False
            heading_level: 3
            show_symbol_type_heading: True
            show_symbol_type_toc: False
            merge_init_into_class: True
            show_signature: True
            separate_signature: True
            annotations_path: source
            filters: ["!^_[^_]"]
  - mike:
      canonical_version: latest
      alias_type: redirect
      redirect_template: null
      deploy_prefix: ""
      version_selector: True
      css_dir: css
      javascript_dir: js

watch:
  - src

remote_branch: documentation

extra:
  version:
    provider: mike
    alias: true
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/saemeon/dygraphs