contraqctor/mkdocs.yml at main · AllenNeuralDynamics/contraqctor · 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: contraqctor
site_description: Documentation for the contraqctor python package.
site_author: Bruno F. Cruz
copyright: 2025, Allen Institute for Neural Dynamics
repo_url: https://github.com/AllenNeuralDynamics/contraqctor
repo_name: GitHub
theme:
  name: material
  palette:
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: white
    accent: black
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: black
    accent: white
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  features:
  - content.tabs.link
  - content.code.annotate
  - content.code.copy
  - announce.dismiss
  - navigation.tabs
  - navigation.instant
  - navigation.instant.prefetch
  - navigation.instant.preview
  - navigation.instant.progress
  - navigation.path
  - navigation.sections
  - navigation.top
  - navigation.tracking
  - search.suggest
  - toc.follow
  logo: logo.svg
  favicon: icon.ico
hooks:
- docs/_regenerate_api.py
plugins:
- search
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          separate_signature: true
          filters:
          - '!^_'
          merge_init_into_class: true
          show_signature_annotations: true
          signature_crossrefs: true
          show_bases: true
          inherited_members: true
          members_order: source
        rendering:
          show_source: true
          show_root_heading: true
        selection:
          docstring_style: google
          inherited_members: true
        inventories:
        - url: https://docs.python.org/3/objects.inv
          domains:
          - py
          - std
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn
markdown_extensions:
- tables
- toc:
    permalink: true
    title: Page contents
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
    pygments_lang_class: true
- pymdownx.extra
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.snippets:
    base_path:
    - .
nav:
- Home: index.md
- API Reference:
  - api/index.md
  - Contract:
    - base: api/contract/base.md
    - camera: api/contract/camera.md
    - core: api/contract/core.md
    - csv: api/contract/csv.md
    - harp: api/contract/harp.md
    - json: api/contract/json.md
    - mux: api/contract/mux.md
    - text: api/contract/text.md
    - utils: api/contract/utils.md
  - Qc:
    - base: api/qc/base.md
    - camera: api/qc/camera.md
    - contract: api/qc/contract.md
    - core: api/qc/core.md
    - csv: api/qc/csv.md
    - harp: api/qc/harp.md
- Issues: https://github.com/AllenNeuralDynamics/contraqctor/issues
- Examples:
  - Contract: doc_examples/contract.md
  - Quality Control: doc_examples/qc.md
watch:
- src/contraqctor