pymisha/mkdocs.yml at main · tanaylab/pymisha · 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
84
85
86
87
88
89
90
91
92
93
site_name: PyMisha
site_url: https://tanaylab.github.io/pymisha/
repo_url: https://github.com/tanaylab/pymisha
repo_name: tanaylab/pymisha

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - scheme: default
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

hooks:
  - hooks/autorefs_filter.py

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

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - Home: index.md
  - Getting Started: guides/quickstart.md
  - Tutorials:
      - Misha Basics (Short Guide): tutorials/misha-basics.md
      - User Manual: tutorials/manual.md
      - Database Formats: tutorials/database-formats.md
      - Creating Genome Databases: tutorials/genomes.md
  - Reference:
      - R Parity: guides/parity.md
      - Changelog: changelog.md
  - API Reference:
      - Overview: api/index.md
      - Database: api/database.md
      - Datasets: api/datasets.md
      - Tracks: api/tracks.md
      - Virtual Tracks: api/vtracks.md
      - Intervals: api/intervals.md
      - Data Operations: api/data-operations.md
      - Liftover: api/liftover.md
      - Sequence Analysis: api/sequence.md
      - Genome Synthesis: api/synthesis.md