pdldb/mkdocs.yml at main · ABChristian/pdldb · 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
site_name: pdldb
site_description: A high-performance analytical data store combining Polars' processing speed with Delta Lake's ACID transactions
site_url: https://0x6761746f.github.io/pdldb/
repo_url: https://github.com/0x6761746F/pdldb
repo_name: 0x6761746F/pdldb

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_category_heading: true
            show_root_heading: true
            heading_level: 2
            docstring_style: google
            docstring_section_style: spacy

nav:
  - Home: index.md
  - API Reference: api/api-reference.md