votuderep/mkdocs.yml at main · quadram-institute-bioscience/votuderep · 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
71
72
73
74
75
76
77
78
79
80
81
82
83
site_name: votuderep Documentation
site_description: Dereplication and filtering of viral operational taxonomic units (vOTUs)
site_author: Andrea Telatin
repo_url: https://github.com/quadram-institute-bioscience/votuderep
repo_name: quadram-institute-bioscience/votuderep

# Directory configuration
docs_dir: docs_src
site_dir: docs

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

nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Quick Start: quickstart.md
  - CLI Commands:
    - Overview: cli/index.md
    - derep: cli/derep.md
    - filter: cli/filter.md
    - getdbs: cli/getdbs.md
    - tabulate: cli/tabulate.md
    - trainingdata: cli/trainingdata.md
    - splitcoverm: cli/splitcoverm.md
  - API Reference: api.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - tables
  - toc:
      permalink: true

extra:
  version: 0.6.0
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/quadram-institute-bioscience/votuderep