Kaptive/mkdocs.yml at master · klebgenomics/Kaptive · 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
site_name: Kaptive Documentation
repo_url: https://github.com/klebgenomics/Kaptive
site_url: https://klebgenomics.github.io/Kaptive
site_description: The tool for _in silico_ serotyping
site_author: Tom Stanton
edit_uri: edit/main/docs/
repo_name: klebgenomics/Kaptive
copyright: 2026, Tom Stanton, Kathryn Holt and Kelly Wyres
watch: [mkdocs.yml, README.md, src]

nav:
  - Home: index.md
  - Installation: Installation.md
  - Usage: Usage.md
  - Method: Method.md
  - Outputs: Outputs.md
  - Interpreting the Results: Interpreting-the-results.md
  - Databases: Databases.md
  - Legacy: Legacy.md
  - FAQs: FAQs.md

plugins:
  - search
  - termynal:
      prompt_literal_start:
        - "$"
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: "google"
  - api-autonav:
      modules: ['src/kaptive']
      nav_section_title: "API Reference"
  - include-markdown
  - offline

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.tabs
    - toc.follow
    - content.action.edit
    - toc.integrate

  logo: assets/logo.png
  favicon: assets/favicon.png

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/klebgenomics/Kaptive
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/kaptive

markdown_extensions:
  - toc:
      permalink: true
      title: On this page
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - footnotes