acquire-docs/mkdocs.yml at main · acquire-project/acquire-docs · 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
site_name: Acquire Zarr Streaming
repo_url: https://github.com/acquire-project/
site_url: https://acquire-project.github.io/acquire-docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - navigation.indexes
    - navigation.tracking
    - content.code.copy
    - toc.follow
  custom_dir: overrides
  palette:
    # Palette toggle shown in light mode
    - scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    # Palette toggle shown in dark mode
    - scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

extra_css:
  - stylesheets/custom.css

extra_javascript:
  - javascripts/version-select.js

nav:
  - Home: index.md
  - Get Started: get_started.md
  - Core concepts: core_concepts.md
  - Examples:
    - examples/index.md
    - examples/python_examples.md
    - examples/c_examples.md
  - API Reference:
    - api_reference/index.md
    - api_reference/zarr_api.md
    - Zarr Streaming C API Reference:
      - api_reference/c_api/index.md
      - acquire_zarr_c_api/acquire_8zarr_8h.md
      - acquire_zarr_c_api/zarr_8types_8h.md
  # - Acquire Imaging:
  #   - acquire-imaging/index.md
  #   - Get Started: acquire-imaging/get_started.md
  #   - API Reference: acquire-imaging/api_reference.md
  #   - Tutorials:
  #     - acquire-imaging/tutorials/index.md
  #     - Setup acquisition:
  #       - acquire-imaging/tutorials/setup_acquisition/index.md
  #       - acquire-imaging/tutorials/setup_acquisition/trigger.md
  #       - acquire-imaging/tutorials/setup_acquisition/configure.md
  #       - acquire-imaging/tutorials/setup_acquisition/start_stop.md
  #       - acquire-imaging/tutorials/setup_acquisition/select.md
  #       - acquire-imaging/tutorials/setup_acquisition/setup.md
  #       - acquire-imaging/tutorials/setup_acquisition/drivers.md
  #       - acquire-imaging/tutorials/setup_acquisition/storage.md
  #     - Using JSON:
  #       - acquire-imaging/tutorials/using_json/index.md
  #       - acquire-imaging/tutorials/using_json/trig_json.md
  #       - acquire-imaging/tutorials/using_json/props_json.md
  #     - Data:
  #       - acquire-imaging/tutorials/access_data/index.md
  #       - acquire-imaging/tutorials/access_data/framedata.md
  #       - acquire-imaging/tutorials/access_data/livestream.md
  #     - Zarr:
  #       - acquire-imaging/tutorials/zarr/index.md
  #       - acquire-imaging/tutorials/zarr/compressed.md
  - For contributors:
    - for_contributors/index.md
    - for_contributors/codebase.md
    - for_contributors/docs_contribution_quickstart.md
    - for_contributors/update_version.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      options:
        custom_icons:
          - overrides/.icons
  - toc:
      permalink: true
  - attr_list
  - pymdownx.magiclink


plugins:
  - include-markdown:
      heading_offset: 1
      rewrite_relative_urls: true
  - search
  - awesome-pages
  - mkdocstrings:
      custom_templates: docs/_templates
      enable_inventory: true  # Create an objects.inv file
      handlers:
        python:
          # Global-only options
          load_external_modules: true
          paths: [../acquire-python/python/acquire, ../acquire-zarr/python/acquire_zarr]
          inventories:
            - https://docs.python.org/3/objects.inv
          options:  # See https://mkdocstrings.github.io/python/usage/#globallocal-options
            # General options
            show_source: false  # Do now show source code for objects
            # Heading options
            show_root_heading: false  # Do now show module name as heading, default
            show_root_toc_entry: false  # Do not create anchor for acquire module itself
            show_root_members_full_path: true  # Show full path for members, i.e.
                                               # acquire.Camera instead of Camera
            show_symbol_type_heading: true  # Show the symbol type in headings (i.e. `method`, `class`)
            # Members options
            members: true  # An explicit list of members to render (true for all)
            inherited_members: false  # Do not render any inherited members (for classes)
            summary: true
            members_order: "alphabetical"  # Order members alphabetically, default
            filters: ["!^_", "!dict", "!setup_", "!gui"]  # Remove private and unwanted members
            show_labels: false  # Whether to show labels of the members
            # Docstring options
            docstring_style: google
            # docstring_options: {}  # Can be customized, see https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_options
            docstring_section_style: table  # The style used to render docstring sections, default
            show_if_no_docstring: false  # Default
            # Signature/annotation options
            annotations_path: "brief"  # The verbosity for annotations path, default
            show_signature_annotations: true  # Show the type annotations in methods and functions signatures
            signature_crossrefs: true  # Whether to render cross-references for type annotations in signatures
  - mkdoxy:
      projects:
        acquire_zarr_c_api: # name of project must be alphanumeric + numbers (without spaces)
          src-dirs: ../acquire-zarr/include # path to source code (support multiple paths separated by space) => INPUT
          full-doc: True # if you want to generate full documentation; i.e. root pages with all objects for a .h file
          doxy-cfg-file: docs/api_reference/Doxyfile
      save-api: docs/api_reference

use_directory_urls: true