makeshift/mkdocs.yml at main · WaymentSteeleLab/makeshift · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
site_name: makeshift
site_description: open-source Python package for accessing and analyzing NMR data
site_url: https://makeshift.readthedocs.io/
repo_url: https://github.com/WaymentSteeleLab/makeshift
repo_name: WaymentSteeleLab/makeshift
edit_uri: edit/main/docs/

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

nav:
  - Home: index.md
  - Getting started:
      - Installation: installation.md
      - Quickstart: quickstart.md
      - Concepts: concepts.md
  - User guide:
      - Reading BMRB entries: guide/entries.md
      - Chemical shifts: guide/chemical-shifts.md
      - Re-referencing: guide/rereferencing.md
      - Peak lists: guide/peaklists.md
      - Spectra: guide/spectra.md
      - Relaxation & dynamics: guide/relaxation.md
      - CPMG processing: guide/cpmg.md
      - HYDRONMR prediction: guide/hydronmr.md
      - TALOS-N prediction: guide/talosn.md
      - RCI flexibility: guide/rci.md
      - Datasets & structures: guide/datasets.md
  - API reference:
      - Overview: api/index.md
      - NMRStarEntry: api/entry.md
      - ChemicalShifts: api/chemshift.md
      - PeakList: api/peaklist.md
      - Spectra: api/spectra.md
      - Re-referencing: api/reref.md
      - Relaxation: api/relaxation.md
      - CPMG: api/cpmg.md
      - HYDRONMR: api/hydronmr.md
      - TALOS-N: api/talosn.md
      - RCI: api/rci.md
      - Utilities: api/utils.md
  - Validation:
      - RCI: rci_validation.md

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            filters:
              - "!^_"
            docstring_section_style: table

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

extra_css:
  - stylesheets/extra.css

watch:
  - makeshift