-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
110 lines (110 loc) · 3.34 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
site_name: Datashare Python
# TODO: set the domain
site_url: https://mydomain.org/
repo_name: ICIJ/datashare-python
repo_url: https://github.com/ICIJ/datashare-python
theme:
name: material
icon:
annotation: material/arrow-right-circle
repo: fontawesome/brands/github
favicon: assets/favicon.png
logo: assets/datashare-logo-color-square.svg
features:
- content.code.annotate
- content.code.copy
- content.code.select
- header.autohide
- navigation.expand
- navigation.footer
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.path
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.top
- search.highlight
- search.share
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/toggle-switch-off
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/link
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.snippets:
base_path: [ "docs/src" ]
check_paths: true
- pymdownx.superfences
- toc:
permalink: true
plugins:
- search
- termynal
nav:
- Home: index.md
- Learn:
- learn/index.md
- Concepts and definitions:
- Basic: learn/concepts-basic.md
- Advanced: learn/concepts-advanced.md
- From functions to tasks:
- Creating async tasks: learn/tasks.md
- Building an app: learn/app.md
- Running a worker pool with the icij-worker CLI: learn/run-worker.md
- Create tasks for Datashare: learn/datashare-app.md
- Get started:
- get-started/index.md
- Implement your own Datashare worker:
- How to use the worker template repo: get-started/implement/index.md
- Basic worker: get-started/implement/worker-basic.md
- Advanced worker: get-started/implement/worker-advanced.md
- Build your worker image: get-started/build.md
- Deploy using Docker: get-started/run.md
- Start your tasks: get-started/start-tasks.md
- Guides:
- guides/index.md
- Configuration:
- Config files and env vars: guides/config/config-files-and-env-vars.md
- Worker config: guides/config/worker-config.md
- App config: guides/config/app-config.md
- Deploy with Docker: guides/deploy-with-docker.md
- Dependency injection: guides/dependency-injection.md
- Datashare index read and writes: guides/datashare-index.md
- Task workflows: guides/task-workflows.md
- Task routing: guides/task-routing.md
- Failure recovery: guides/failure-recovery.md
- Testing: guides/testing.md
- Progress updates: guides/progress-updates.md
- FAQ: faq.md