xarray_plotly/mkdocs.yml at main · FBumann/xarray_plotly · 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
site_name: xarray_plotly
site_description: Interactive Plotly Express plotting accessor for xarray
site_url: https://fbumann.github.io/xarray_plotly
repo_url: https://github.com/FBumann/xarray_plotly
repo_name: FBumann/xarray_plotly

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight

plugins:
  - search
  - mkdocs-jupyter:
      include_source: true
      execute: true
      include_requirejs: true
  - plotly
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            members_order: source

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: plotly
          class: mkdocs-plotly
          format: !!python/name:mkdocs_plotly_plugin.fences.fence_plotly
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.ipynb
  - Examples:
      - Plot Types: examples/plot-types.ipynb
      - Dataset Plotting: examples/datasets.ipynb
      - Dimensions & Facets: examples/dimensions.ipynb
      - Plotly Express Options: examples/kwargs.ipynb
      - Figure Customization: examples/figure.ipynb
      - Combining Figures: examples/combining.ipynb
      - Figure Manipulation: examples/manipulation.ipynb
      - Fast Bar Charts: examples/fast_bar.ipynb
  - API Reference: api.md