Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
101 lines (94 loc) · 2.74 KB
/
Copy pathmkdocs.yml
File metadata and controls
101 lines (94 loc) · 2.74 KB
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
site_name: TESK
site_description: >-
GA4GH Task Execution Service on Kubernetes, by ELIXIR On-Cloud
# Read the Docs serves each version under its own path (e.g., `/en/latest/`)
site_url: !ENV [READTHEDOCS_CANONICAL_URL, "https://tesk.readthedocs.io/en/latest/"]
repo_url: https://github.com/elixir-cloud-aai/TESK
repo_name: elixir-cloud-aai/TESK
edit_uri: edit/dev/docs/
copyright: Copyright © ELIXIR On-Cloud
# Python hooks of the build (not part of the site, nor their bytecode)
exclude_docs: |
hooks.py
__pycache__/
# Pull the docs of tesk-api and tesk-core (`docs-sources.yml`) into the
# sections marked `external:<name>` in `nav` (see `docs/hooks.py`)
hooks:
- docs/hooks.py
watch:
- docs-sources.yml
theme:
name: material
features:
- content.code.copy
- content.action.edit
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.top
- search.highlight
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: purple
toggle:
icon: material/brightness-4
name: Switch to light mode
markdown_extensions:
- admonition
- attr_list
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
permalink: true
plugins:
- search
# Pages of the earlier Sphinx docs, which may be linked from elsewhere
- redirects:
redirect_maps:
tesintro.html.md: tesintro.md
deployment.html.md: deployment.md
integrated_wes_tes.html.md: integrated_wes_tes.md
local_ftp.html.md: local_ftp.md
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
# `external:<name>` marks the section of the docs pulled from another
# repository (`docs-sources.yml`, `docs/hooks.py`)
nav:
- Home: index.md
- Introduction to TES: tesintro.md
- Architecture: architecture.md
- Deployment: deployment.md
- Configuration: configuration.md
- API: api.md
- Upgrading: upgrading.md
# The curated notes of each release (`docs/releases/<version>.md`), newest
# first (see "Releases" in `docs/development.md`)
- Releases:
- "0.4.0": releases/0.4.0.md
- "0.3.0": releases/0.3.0.md
- Guides:
- Integration with WES: integrated_wes_tes.md
- TESK on MicroK8s: microk8s.md
- Local FTP server: local_ftp.md
- tesk-api: external:tesk-api
- tesk-core: external:tesk-core
- Development: development.md