/
mkdocs.yml
164 lines (155 loc) · 4.25 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
154
155
156
157
158
159
160
161
162
163
164
## Project information
site_name: UP42 Python SDK
site_url: https://up42.github.io/up42-py/
site_description: UP42 Python SDK
## Repository
repo_name: up42-py
repo_url: https://github.com/up42/up42-py
edit_uri: '' #disables edit button
# Copyright
copyright: UP42 2020
## Social Media
extra:
social:
- icon: fontawesome/solid/home
link: https://up42.com
- icon: fontawesome/brands/github-alt
link: https://github.com/up42
- icon: fontawesome/brands/twitter
link: https://twitter.com/up42_
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/up42/
- icon: fontawesome/solid/envelope
link: mailto:support@up42.com
## Page tree
nav:
- Home: index.md
- Getting Started:
- 30 Second Example: 30-second-example.md
- Installation: installation.md
- Authentication: authentication.md
- Structure: structure.md
- Catalog Search: catalog.md
- Detailed Example: detailed-example.md
- Examples:
- Examples: examples-intro.md
- Radar processing: examples/radar_processing_1.ipynb
- Airport monitoring: examples/airports-parallel.ipynb
- Flood mapping: examples/flood_mapping.ipynb
- Catalog Quicklooks: examples/catalog-quicklooks.ipynb
- Code Reference:
- up42: reference/up42-reference.md
- Project: reference/project-reference.md
- Workflow: reference/workflow-reference.md
- Job: reference/job-reference.md
- JobCollection: reference/jobcollection-reference.md
- JobTask: reference/jobtask-reference.md
- Catalog: reference/catalog-reference.md
- CLI: reference/cli-reference.md
- CLI:
- Command Line Interface (CLI): cli.md
- Command Reference: reference/cli-reference.md
- Changelog & FAQ:
- Changelog: CHANGELOG.md
- FAQ & Support: support-faq.md
- Privacy Policy: privacy-policy.md
## Configuration
theme:
name: material
custom_dir: docs/theme_override_home/
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
- navigation.tabs
palette:
primary: indigo
accent: purple
font:
text: Roboto
code: Roboto Mono
icon: # from .icons path. Add to theme override for custom logo.
logo: up42-logo # top left header logo
favicon: assets/logo-up42.ico #browser tab logo
## Plugins
plugins:
- search
- autolinks
- table-reader
- mkdocs-jupyter
- exclude:
glob:
- "*config*.json"
- "*cfg*.json"
- ".ipynb_checkpoints"
- "*examples/project*"
- "*examples/guides/*"
- exclude-search:
exclude:
- cli-reference.md
ignore:
- cli-reference.md#command-line-interface-cli
#- minify:
# minify_html: false
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_root_heading: false
show_source: true
show_category_heading: true
selection:
filters:
- "!^_" # exlude all members starting with _
watch:
- src/my_library
#- pdf-export
## Custom theme additions
extra_javascript:
- 'stylesheets/extra.js'
extra_css:
- stylesheets/extra.css
## Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.attr_list
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
baselevel: 1
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji
# - pymdownx.highlight:
# linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- pymdownx.tabbed
- mkdocs-click
google_analytics:
- 'UA-132885718-1'
- 'auto'