forked from nsidc/earthaccess
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
123 lines (115 loc) · 4.05 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
site_name: earthaccess
site_description: Client library for NASA Earthdata APIs
site_url: https://github.com/nsidc/earthaccess
# Fail on broken links
strict: true
theme:
name: "material"
logo: earth.png
favicon: earth.png
palette:
- scheme: default
primary: teal
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
# Allow navigation sections to link to index/overview pages.
# See: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
- navigation.indexes
repo_name: nsidc/earthaccess
repo_url: https://github.com/nsidc/earthaccess
edit_uri: ""
extra_css:
- css/styles.css
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
options:
docstring_style: google
docstring_options:
ignore_init_summary: no
merge_init_into_class: yes
show_submodules: no
rendering:
show_root_heading: false
show_source: false
- redirects:
redirect_maps:
'CODE_OF_CONDUCT.md': 'contributing/code-of-conduct.md'
'CODE_OF_CONDUCT.md.md': 'contributing/code-of-conduct.md'
- mkdocs-jupyter:
execute: True
ignore:
- "tutorials/dask.ipynb"
- "**/.ipynb_checkpoints/*"
nav:
- "What is earthaccess?": "index.md"
- "Quick start": "quick-start.md"
- "Work with us":
- "contributing/index.md"
- "Development": "contributing/development.md"
- "Releasing": "contributing/releasing.md"
- "Our meet-ups": "contributing/our-meet-ups.md"
- "Maintainers Guide": "contributing/maintainers-guide.md"
- "Code of Conduct": "contributing/code-of-conduct.md"
- "Resources": "resources.md"
- USER GUIDE:
- "user_guide/index.md"
- "Authentication": "user_guide/authenticate.md"
- "Search": "user_guide/search.md"
- "Access": "user_guide/access.md"
- HOW-TO:
- "Authenticate with Earthdata Login": "howto/authenticate.md"
- "Search NASA datasets using filters": "howto/search-collections.md"
- "Search for data using filters": "howto/search-granules.md"
- "Determine if a dataset is available in the cloud": "howto/storage-location.md"
- "Access data": "howto/access-data.md"
- "Using authenticated sessions to access data": "howto/edl.ipynb"
- "Download data from on-prem location": "howto/onprem.md"
- "Direct S3 access - Open/stream files in the cloud": "howto/cloud.md"
- TUTORIALS:
- "Accessing remote NASA data with fsspec": "tutorials/file-access.ipynb"
- "Search and access of restricted datasets": "tutorials/restricted-datasets.ipynb"
- "Reproducing NASA sea level rise infographic": "tutorials/SSL.ipynb"
- "Accessing and visualizing EMIT data with a few lines of code": "tutorials/emit-earthaccess.ipynb"
- USER REFERENCE:
- API:
- "Search and Access": "user-reference/api/api.md"
- Modules:
- Collections:
- "Collection Queries": "user-reference/collections/collections-query.md"
- "Collection Results": "user-reference/collections/collections.md"
- Granules:
- "Granule Queries": "user-reference/granules/granules-query.md"
- "Granule Results": "user-reference/granules/granules.md"
- Store:
- "Store": "user-reference/store/store.md"
- Auth:
- "Auth": "user-reference/auth/auth.md"
- Glossary:
- "NASA Glossary": "user-reference/glossary/nasa-glossary.md"
- "Cloud Computing Terminology": "user-reference/glossary/cloud-glossary.md"
markdown_extensions:
- admonition
- callouts
- pymdownx.details
- meta
- toc:
toc_depth: 2
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
watch:
- docs
- earthaccess
- notebooks