AbovePy/mkdocs.yml at main · chrislyonsKY/AbovePy · 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
site_name: abovepy
site_description: KyFromAbove LiDAR, DEM, and orthoimagery access for Python
site_author: Chris Lyons
site_url: https://chrislyonsKY.github.io/AbovePy/
repo_url: https://github.com/chrislyonsKY/AbovePy
repo_name: chrislyonsKY/AbovePy
edit_uri: edit/main/docs/

theme:
  variant: modern
  custom_dir: overrides
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: lucide/sun
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: light green
      toggle:
        icon: lucide/moon
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - navigation.sections
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/chrislyonsKY/AbovePy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            docstring_style: numpy
            show_root_heading: true
            show_root_full_path: false
            heading_level: 3
            members_order: source

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Tutorials:
    - DEM + Hillshade: tutorials/dem-hillshade.md
    - LiDAR Access: tutorials/lidar-access.md
    - Web Maps (TiTiler): tutorials/titiler-maps.md
    - Validating Formats: tutorials/validation.md
    - ArcGIS Pro Toolbox: tutorials/arcgis-pro.md
    - Troubleshooting: tutorials/troubleshooting.md
  - KyFromAbove Collections: stac-collections.md
  - Architecture: architecture.md
  - API Reference:
    - Overview: api/reference.md
    - Client: api/client.md
    - Products: api/products.md
    - SearchResult: api/result.md
    - I/O (Raster & Point Cloud): api/io.md
    - TiTiler URL Helpers: api/titiler.md
    - Utilities: api/utils.md
    - Exceptions: api/exceptions.md
  - Community:
    - Start Here: community/start-here.md
    - Contributing: community/contributing.md
    - Development: community/development.md
    - Support: community/support.md
    - Governance: community/governance.md
    - Security: community/security.md
    - Roadmap: community/roadmap.md
    - Maintainers: community/maintainers.md
    - Responsible Use: community/responsible-use.md
    - Attribution: community/attribution.md
    - Disclaimer: community/disclaimer.md
    - Privacy: community/privacy.md

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true