ckanext-charts/mkdocs.yml at master · okfn/ckanext-charts · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
site_name: ckanext-charts
site_url: https://.github.io/ckanext-charts/

repo_url:  https://github.com/DataShades/ckanext-charts

markdown_extensions:
    - pymdownx.snippets
    - admonition
    - pymdownx.details
    - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
    - pymdownx.tabbed:
            alternate_style: true


plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: ["ckanext"]
          options:
            show_root_full_path: false
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_source: false
            docstring_section_style: spacy
        ChartFieldsHandler:
          handler_config_option: yes
  - search:
      separator: '[\s\-\.\_]+'

watch:
  - README.md
  - ckanext/charts/

theme:
  name: material
  logo: image/logo.png
  favicon: image/favicon.ico
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.footer
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.code.select
    - content.code.annotate

nav:
  - index.md
  - install.md
  - usage.md
  - configuration.md

  - Engines:
    - engines/index.md

    - Plotly:
      - engines/plotly/index.md
      - engines/plotly/bar.md
      - engines/plotly/hbar.md
      - engines/plotly/line.md
      - engines/plotly/pie.md
      - engines/plotly/scatter.md
      - engines/plotly/choropleth.md

    - ChartJS:
      - engines/chartjs/index.md
      - engines/chartjs/bar.md
      - engines/chartjs/hbar.md
      - engines/chartjs/line.md
      - engines/chartjs/pie.md
      - engines/chartjs/doughnut.md
      - engines/chartjs/scatter.md
      - engines/chartjs/bubble.md
      - engines/chartjs/radar.md

    - Observable:
      - engines/observable/index.md
      - engines/observable/bar.md
      - engines/observable/hbar.md
      - engines/observable/pie.md
      - engines/observable/line.md
      - engines/observable/scatter.md

    - Echarts:
      - engines/echarts/index.md
      - engines/echarts/bar.md
      - engines/echarts/line.md
      - engines/echarts/pie.md

    - engines/custom.md

  - Caching:
    - caching/index.md
    - caching/base.md
    - caching/redis.md
    - caching/file.md

  - Fetchers:
    - fetchers/index.md
    - fetchers/base.md
    - fetchers/datastore.md
    - fetchers/url.md
    - fetchers/file.md
    - fetchers/hardcode.md

  - validators.md
  - utils.md
  - helpers.md
  - troubleshooting.md