suite2p/mkdocs.yml at main · MouseLand/suite2p · 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
site_name: Suite2p Documentation

repo_name: mouseland/suite2p
repo_url: https://github.com/mouseland/suite2p

theme:
  name: material
  logo: _static/favicon.ico
  favicon: _static/favicon.ico
  palette:
    primary: green
  features:
    - navigation.expand

nav:
  - Home: index.md
  - Basics:
      - Installation: installation.md
      - Inputs: inputs.md
      - Parameters: parameters.md
      - Using the GUI: gui.md
      - Outputs: outputs.md
      - Multiday recordings: multiday.md
      - Developer Doc: developer_doc.md
      - Frequently asked questions: FAQ.md
  - How it Works:
      - Registration: registration.md
      - ROI Detection: roidetection.md
      - Signal Extraction: roiextraction.md
      - Spike Deconvolution: deconvolution.md
      - ROI Classification: classification.md
  - API:
      - IO: api/io.md
      - Registration: api/registration.md
      - Detection: api/detection.md
      - Extraction: api/extraction.md
      - Classification: api/classification.md
      - GUI: api/gui.md

#hooks:
#  - generate_settings_docs.py # Necessary for parameters.md generation

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            separate_signature: true
            show_if_no_docstring: false
            docstring_style: numpy
            members_order: alphabetical

extra_css:
  - css/API.css # Necessary for API documentation


markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.emoji
  - pymdownx.tabbed
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.extra
  - toc:
      permalink: "#"
      permalink_title: Anchor link to this section for reference