-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
153 lines (141 loc) · 3.82 KB
/
mkdocs.yml
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
141
142
143
144
145
146
147
148
149
150
151
152
153
site_name: 'Documentation'
site_description: 'A powerful Python package for geospatial data analysis and processing'
site_author: 'Utku Can Ozturk'
theme:
name: material
palette:
# Palette toggle for automatic mode
- 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
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
logo: assets/logo.png
favicon: assets/GIGA_horizontal_notext_white.webp
features:
- navigation.tabs
- navigation.sections
- navigation.top
- navigation.tracking
- navigation.indexes
- navigation.instant
- navigation.footer
- search.suggest
- search.highlight
- search.share
- content.tabs.link
- content.code.copy
- content.code.annotate
repo_name: giga-spatial
repo_url: https://github.com/unicef/giga-spatial
edit_uri: edit/main/docs/
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- Configuration: getting-started/configuration.md
- User Guide:
- Overview: user-guide/index.md
#- Basic Usage: user-guide/basic-usage.md
#- Advanced Features: user-guide/advanced-features.md
#- Best Practices: user-guide/best-practices.md
- API Reference:
- Overview: api/index.md
#- Core Functions: api/core.md
#- Utilities: api/utils.md
#- Data Types: api/data-types.md
- Examples:
- Overview: examples/index.md
- Basic Examples: examples/basic.md
- Advanced Examples: examples/advanced.md
- Use Cases: examples/use-cases.md
- Contributing:
- How to Contribute: contributing.md
#- Development Setup: contributing/development-setup.md
#- Code Style Guide: contributing/code-style.md
- About:
- Changelog: changelog.md
- License: license.md
#- Credits: credits.md
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.snippets
# - pymdownx.emoji:
# emoji_index: !!python/name:materialx.emoji.twemoji
# emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: true
show_category_heading: true
show_root_heading: true
show_signature_annotations: true
#- git-revision-date-localized:
# enable_creation_date: true
- minify:
minify_html: true
- social:
cards_layout_options:
background_color: blue
color: white
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/unicef/giga-spatial
- icon: fontawesome/brands/python
link: https://pypi.org/project/giga-spatial/
version:
provider: mike
generator: false
extra_css:
- stylesheets/extra.css
copyright: Copyright © 2025 Giga