PyCanopy/mkdocs.yml at main · pranav-walimbe/PyCanopy · 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
site_name: PyCanopy
site_url: https://pranav-walimbe.github.io/PyCanopy
repo_url: https://github.com/pranav-walimbe/PyCanopy
repo_name: pranav-walimbe/PyCanopy

theme:
  name: material
  palette:
    scheme: default
    primary: custom
    accent: custom
  logo: assets/pycanopy_logo3.png
  favicon: assets/pycanopy_logo3.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - toc.integrate
    - content.code.copy

extra_css:
  - stylesheets/extra.css

hooks:
  - hooks.py

nav:
  - Introduction:
    - Overview: index.md
    - Benchmarks: benchmarks.md
  - Quick Start: quickstart.md
  - API Reference:
    - SpatialFrame: api/spatial-frame.md
    - SpatialLazyFrame: api/lazy-frame.md
    - Aggregations: api/aggregations.md
    - Engine: api/engine.md
    - Planar and Geographic Distances: api/coordinate-reference-system.md
  - How It Works:
    - Architecture Overview: how-it-works/architecture.md
    - Data Ingestion: how-it-works/data-ingestion.md
    - Spatial Query Planning: how-it-works/query-planner.md
    - Query Execution: how-it-works/execution-paths.md
    - Native Access Planning: how-it-works/cost-model.md
    - Morsel Execution and Aggregation: how-it-works/streaming.md
  - Contributing: contributing.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            heading_level: 2

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - tables

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js