forked from cogeotiff/rio-tiler
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
115 lines (108 loc) · 3.43 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
# Project Information
site_name: 'rio-tiler'
site_description: 'User friendly Rasterio plugin to read raster datasets.'
docs_dir: 'docs'
site_dir: 'build'
# Repository
repo_name: 'cogeotiff/rio-tiler'
repo_url: 'https://github.com/cogeotiff/rio-tiler'
edit_uri: 'blob/master/docs/src/'
site_url: 'https://cogeotiff.github.io/rio-tiler/'
# Social links
extra:
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/cogeotiff'
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/cogeotiff'
- icon: 'fontawesome/solid/globe'
link: 'https://www.cogeo.org/'
# Layout
nav:
- Home: 'index.md'
- User Guide:
- Introduction: 'intro.md'
- Readers: 'readers.md'
- Models: 'models.md'
- Mosaic: 'mosaic.md'
- Colormaps: 'colormap.md'
- Supported file formats: 'supported_format.md'
- Advanced Topics:
- Read Polygon-shaped regions: 'advanced/feature.md'
- Base classes and custom readers: 'advanced/custom_readers.md'
- Create a Dynamic Tiler: 'advanced/dynamic_tiler.md'
- TileMatrixSet: 'advanced/tms.md'
- Examples:
- Introduction: 'examples/Using-rio-tiler.ipynb'
- Mosaic: 'examples/Using-rio-tiler-mosaic.ipynb'
- rio-tiler + morecantile: 'examples/Using-tms.ipynb'
- rio-tiler + STAC: 'examples/Using-rio-tiler-STACReader.ipynb'
- API:
- rio_tiler.colormap: api/rio_tiler/colormap.md
- rio_tiler.constants: api/rio_tiler/constants.md
- rio_tiler.errors: api/rio_tiler/errors.md
- rio_tiler.expression: api/rio_tiler/expression.md
- rio_tiler.models: api/rio_tiler/models.md
- rio_tiler.io:
- rio_tiler.io.base: api/rio_tiler/io/base.md
- rio_tiler.io.cogeo: api/rio_tiler/io/cogeo.md
- rio_tiler.io.stac: api/rio_tiler/io/stac.md
- rio_tiler.mosaic:
- rio_tiler.mosaic.reader: api/rio_tiler/mosaic/reader.md
- rio_tiler.mosaic.methods:
- rio_tiler.mosaic.methods.base: api/rio_tiler/mosaic/methods/base.md
- rio_tiler.mosaic.methods.defaults: api/rio_tiler/mosaic/methods/defaults.md
- rio_tiler.profiles: api/rio_tiler/profiles.md
- rio_tiler.reader: api/rio_tiler/reader.md
- rio_tiler.tasks: api/rio_tiler/tasks.md
- rio_tiler.utils: api/rio_tiler/utils.md
- Migration from v1.0 to v2.0: 'v2_migration.md'
- Development - Contributing: 'contributing.md'
- Release Notes: 'release-notes.md'
plugins:
- search
- mkdocs-jupyter:
include_source: True
# Theme
theme:
icon:
logo: 'material/home'
repo: 'fontawesome/brands/github'
name: 'material'
language: 'en'
palette:
primary: 'blue'
accent: 'light blue'
font:
text: 'Nunito Sans'
code: 'Fira Code'
custom_dir: 'docs/overrides'
# These extensions are chosen to be a superset of Pandoc's Markdown.
# This way, I can write in Pandoc's Markdown and have it be supported here.
# https://pandoc.org/MANUAL.html
markdown_extensions:
- admonition
- attr_list
- codehilite:
guess_lang: false
- def_list
- footnotes
- pymdownx.arithmatex
- pymdownx.betterem
- pymdownx.caret:
insert: false
- pymdownx.details
- pymdownx.emoji
- pymdownx.escapeall:
hardbreak: true
nbsp: true
- pymdownx.magiclink:
hide_protocol: true
repo_url_shortener: true
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- toc:
permalink: true