MHC-TP/mkdocs.yml at main · PurcellLab/MHC-TP · 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
site_name: MHC-TP
site_description: Cluster immunopeptidomics peptides by HLA/MHC binding motif, with an interactive HTML report
site_url: https://purcelllab.github.io/MHC-TP/
repo_url: https://github.com/PurcellLab/MHC-TP
repo_name: PurcellLab/MHC-TP
edit_uri: ""
docs_dir: docs

theme:
  name: material
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - search.suggest
    - toc.follow

nav:
  - Home: index.md
  - Usage: usage.md
  - API reference: api.md
  - LLM guide: llm.md
  - Example reports:
      - Human (class I + II): example-report.html
      - Human — class I: examples/human-classI.html
      # - Human — class II: examples/human-classII.html  # add when a class II dataset is available
      - Mouse: examples/mouse.html

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_root_heading: true
            show_source: true
            members_order: source
            separate_signature: true
            docstring_section_style: list

hooks:
  - docs_hooks.py

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/copy-page.js

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite