Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
118 lines (111 loc) · 3.26 KB
/
Copy pathmkdocs.yml
File metadata and controls
118 lines (111 loc) · 3.26 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
site_name: proTES
site_description: >-
Gateway for the GA4GH Task Execution Service API 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://protes.readthedocs.io/en/latest/"]
repo_url: https://github.com/elixir-cloud-aai/protes
repo_name: elixir-cloud-aai/protes
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__/
hooks:
- docs/hooks.py
# Files included in pages (see `docs/hooks.py` and `pymdownx.snippets`)
watch:
- README.md
- deployment/README.md
theme:
name: material
features:
- content.code.copy
- 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
# Sections of `README.md` (between `--8<-- [start:<name>]` and
# `--8<-- [end:<name>]`), so that they are not written twice; fails if a
# file or section is missing
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
permalink: true
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: ["."]
options:
docstring_style: google
# Fields of pydantic models are documented as `Args`, but have no
# signature that griffe could check them against
docstring_options:
warn_unknown_params: false
warn_missing_types: false
show_source: false
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
separate_signature: true
members_order: source
merge_init_into_class: true
filters: ["!^_"]
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
# Add the notes of each release (`docs/releases/<version>.md`, read by the
# release workflow) to "Changelog"; the build fails for notes missing here
nav:
- Home: index.md
- Getting started: getting-started.md
- Configuration: configuration.md
- API: api.md
- TES versions: tes-versions.md
- Plugins: plugins.md
- Plugin images: plugin-images.md
- Access control: access-control.md
- Deployment: deployment.md
- Operations: operations.md
- Upgrading: upgrading.md
- Development: development.md
- Contributing: contributing/index.md
- API reference: reference.md
- Changelog:
- changelog.md
- "0.6.0": releases/0.6.0.md
- "0.5.0": releases/0.5.0.md
- "0.4.0": releases/0.4.0.md
- "0.3.0": releases/0.3.0.md