zoo-runner-common/mkdocs.yml at main · ZOO-Project/zoo-runner-common · GitHub

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
site_name: zoo-runner-common
site_description: Common utilities for ZOO-Project CWL runners
site_author: ZOO-Project
repo_url: https://github.com/ZOO-Project/zoo-runner-common
repo_name: ZOO-Project/zoo-runner-common

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.suggest
    - search.highlight
    - content.code.copy

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - BaseRunner: user-guide/base-runner.md
      - ZooConf: user-guide/zoo-conf.md
      - ZooStub: user-guide/zoo-stub.md
  - API Reference:
      - BaseRunner: api/base-runner.md
      - ZooConf: api/zoo-conf.md
  - Development:
      - Contributing: development/contributing.md
      - Implementing Runners: development/implementing-runners.md
  - About:
      - Changelog: about/changelog.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            docstring_style: google