varcode/mkdocs.yml at main · openvax/varcode · 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
site_name: varcode
site_description: Library for manipulating genomic variants and predicting their effects
site_url: https://openvax.github.io/varcode/
repo_url: https://github.com/openvax/varcode
repo_name: openvax/varcode
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode

nav:
  - Home: index.md
  - Feature guides:
      - Effect annotation: effect_annotation.md
      - Genotypes & sample queries: genotype.md
      - VariantCollection transforms: transforms.md
      - CSV round-trip: csv.md
      - Error handling: errors.md
      - Germline-aware annotation: germline.md
  - API reference: api.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - def_list
  - footnotes
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - .
        - docs
  - pymdownx.superfences
  - tables

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_signature_annotations: true
            members_order: source
            docstring_style: numpy
            docstring_section_style: spacy
            merge_init_into_class: true