flatbread/mkdocs.yml at master · flatbread-dataframes/flatbread · 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
site_name: Flatbread
site_url: https://flatbread-dataframes.github.io/flatbread/
site_description: Pandas extension for aggregation and tabular display
repo_url: https://github.com/flatbread-dataframes/flatbread

theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  custom_dir: docs/overrides
  features:
    - content.code.copy
    - navigation.tabs

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_root_heading: true
            show_source: false
            members_order: source

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: docs

nav:
  - Home: index.md
  - Guide:
    - Getting Started: guide/getting-started.md
    - Aggregation: guide/aggregation.md
    - Panels: guide/panels.md
    - Configuration: guide/configuration.md
    - Formatting: guide/formatting.md
    - Display & Export: guide/display.md
  - API Reference:
    - PitaFrame: api/dataframe.md
    - PitaSeries: api/series.md
    - Display: api/display.md

hooks:
  - docs/hooks/flatbread_table.py
  - docs/hooks/build_examples.py