winnow/mkdocs.yml at main · instadeepai/winnow · 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
site_name: Winnow
site_description: Confidence calibration and FDR control for de novo peptide sequencing
site_author: InstaDeep Developers
site_url: https://instadeepai.github.io/winnow/
site_dir: docs_public
repo_name: instadeepai/winnow
repo_url: https://github.com/instadeepai/winnow
strict: false

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: white
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  logo: assets/instadeep-logo.png
  favicon: assets/instadeep-logo.png
  icon:
    repo: fontawesome/brands/github
  font:
    text: Avenir Next
  features:
    - navigation.tracking # the URL is automatically updated with the active anchor
    - navigation.sections # top-level sections are rendered as groups in the sidebar
    - navigation.tabs # horizontal tabs at the top of the page
    - navigation.tabs.sticky # navigation tabs will lock below the header and always remain visible when scrolling
    - search.highlight # highlight search result
    - search.share # share button
    - search.suggest # smart suggestion
    - content.code.annotate
    - navigation.top

markdown_extensions:
  - tables
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - markdown_include.include:
      base_path: '.'
  - toc:
      permalink: true

plugins:
  - search

nav:
  - Home: index.md
  - User guide:
    - CLI reference: cli.md
    - Configuration guide: configuration.md
    - Examples: examples.md
  - API reference:
    - Datasets: api/datasets.md
    - Calibration: api/calibration.md
    - FDR: api/fdr.md
  - Contributing: contributing.md
  - License: license.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/instadeepai/winnow