-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
105 lines (95 loc) · 2.8 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
# mkdocs.yml
site_name: "Dataherb"
site_author: L Ma
site_description: "Dataherb is a dataset management system lives in your terminal"
site_url: "https://dataherb.github.io/dataherb-python"
repo_url: "https://github.com/dataherb/dataherb-python"
edit_uri: "blob/master/docs/"
repo_name: "dataherb/dataherb-python"
theme:
name: "material"
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
# - navigation.instant
- navigation.sections
- navigation.tabs
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
favicon: assets/favicon/ms-icon-310x310.png
logo: assets/logos/logo.png
markdown_extensions:
- admonition
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- toc:
permalink: "¤"
plugins:
- autorefs
- search
- mkdocstrings:
handlers:
python:
setup_commands:
- import sys
- sys.path.append("docs")
selection:
docstring_style: "sphinx"
docstring_section_style: "spacy"
members: yes
filters:
- "^_[^_]"
watch:
- dataherb
nav:
- "Home": index.md
- "Tutorials":
- "Tutorials": tutorials/index.md
- "Configuration": tutorials/configuration/index.md
- "Create Dataset": tutorials/create/index.md
- "Search Dataset": tutorials/search/index.md
- "Download Dataset": tutorials/download/index.md
- "Serve Flora": tutorials/serve/index.md
- "Remove Dataset": tutorials/remove/index.md
- "Command Line Tool": references/command.md
- References:
- "Introduction": references/index.md
- "dataherb.flora": "references/flora.md"
- "dataherb.cmd":
- "cmd.create": references/cmd/create.md
- "cmd.search": references/cmd/search.md
- "cmd.sync_git": references/cmd/sync_git.md
- "cmd.sync_s3": references/cmd/sync_s3.md
- "dataherb.core":
- "dataherb.core.base": references/core/base.md
- "dataherb.core.search": references/core/search.md
- "dataherb.parse":
- "dataherb.parse.model_json": references/parse/model_json.md
- "dataherb.utils":
- "dataherb.utils.awscli": references/utils/awscli.md
- "dataherb.utils.data": references/utils/data.md
- "Changelog": changelog.md
extra_javascript:
- 'https://unpkg.com/[email protected]/dist/mermaid.min.js'