forked from argoproj-labs/hera
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
152 lines (149 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
---
site_name: Hera
site_author: Flaviu Vadan, Sambhav Kothari, Elliot Gunton
copyright: Copyright © 2023 Flaviu Vadan, Sambhav Kothari, Elliot Gunton
nav:
- Home: README.md
- Walk Through:
- walk-through/quick-start.md
- walk-through/about-hera.md
- walk-through/hera-tour.md
- walk-through/hello-world.md
- walk-through/parameters.md
- walk-through/steps.md
- walk-through/dag.md
- walk-through/artifacts.md
- walk-through/loops.md
- walk-through/conditionals.md
- walk-through/suspending.md
- Advanced Features:
- walk-through/authentication.md
- walk-through/advanced-workflow-features.md
- walk-through/advanced-template-features.md
- walk-through/advanced-hera-features.md
- walk-through/pydantic-support.md
- Contributing:
- Contributing Guide: CONTRIBUTING.md
- History of Hera: contributing/history.md
- User Guides:
- Core Concepts: user-guides/core-concepts.md
- Scripts:
- Script Basics: user-guides/script-basics.md
- Script Annotations: user-guides/script-annotations.md
- Script Runner IO: user-guides/script-runner-io.md
- Expr Transpiler: user-guides/expr.md
- Examples:
- About: examples/workflows-examples.md
- Idiomatic Hera Examples:
- Scripts:
- ... | flat | examples/workflows/scripts/*.md
- DAGs:
- ... | flat | examples/workflows/dags/*.md
- Steps:
- ... | flat | examples/workflows/steps/*.md
- Loops:
- ... | flat | examples/workflows/loops/*.md
- Artifacts:
- ... | flat | examples/workflows/artifacts/*.md
- Experimental Features:
- ... | flat | examples/workflows/experimental/*.md
- Miscellaneous Examples:
- ... | flat | examples/workflows/*.md
- Use-Cases and Integrations:
- About: examples/about-use-cases.md
- ... | flat | examples/workflows/use-cases/*.md
- Upstream Examples:
- About: examples/about-upstream.md
- ... | flat | examples/workflows/upstream/*.md
- API Reference:
- Shared: api/shared.md
- Workflows:
- Hera: api/workflows/hera.md
- Models: api/workflows/models.md
- Events:
- Models: api/events/models.md
theme:
custom_dir: docs/overrides
font:
text: Roboto
code: Roboto Mono
name: material
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: deep purple
toggle:
icon: material/weather-night
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: deep purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- content.code.copy
- content.code.select
- search.suggest
- search.share
- search.highlight
- content.tabs.link
repo_url: https://github.com/argoproj-labs/hera
repo_name: argoproj-labs/hera
edit_uri: blob/main/docs
extra:
version:
provider: mike
markdown_extensions:
- admonition
- smarty
- attr_list
- mkdocs-click
- pymdownx.smartsymbols
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
# slugify: !!python/object/apply:pymdownx.slugs.slugify
# kwds:
# case: lower
plugins:
- awesome-pages
- include-markdown
- autorefs
- mkdocstrings:
watch:
- src
handlers:
python:
options:
# show_category_heading: true
show_if_no_docstring: true
inherited_members: true
filters: ["!^_.*$"]
show_bases: false
separate_signature: true
docstring_style: google
rendering:
show_source: true
paths: [src]
import:
- https://docs.python.org/3/objects.inv
- search:
lang: en