mzmlpy/mkdocs.yml at main · tacular-omics/mzmlpy · 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
site_name: mzmlpy
site_description: A lightweight Python library for parsing mzML mass spectrometry files.
repo_url: https://github.com/tacular-omics/mzmlpy
repo_name: tacular-omics/mzmlpy
theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.highlight

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Benchmarks: benchmarks.md
  - API Reference:
    - Mzml Reader: api/mzml.md
    - Spectrum: api/spectrum.md
    - Chromatogram: api/chromatogram.md
    - Lookup: api/lookup.md
    - Precursor & Ions: api/precursor.md
    - File Description: api/file-description.md
    - Instrument: api/instrument.md
    - Data Processing: api/data-processing.md
    - Metadata: api/metadata.md
    - CV Parameters: api/params.md
    - Constants: api/constants.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            members_order: source
            inherited_members: true
            merge_init_into_class: true
            filters: ["!^_"]
            show_signature_annotations: true
            separate_signature: true
            annotations_path: source
            signature_crossrefs: true

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - admonition