lavlab-python-utils/mkdocs.yml at main · bench-mcw/lavlab-python-utils · 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
# mkdocs.yml
site_name: LavLab Python Utils
site_description: Documentation for LaViolette Lab Python Utilities
site_author: LaViolette Lab
site_url: https://lavlab-python-utils.readthedocs.io/stable/

theme:
  name: material

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            collecting: true

  - git-revision-date-localized
  - minify:
      minify_html: true
  - autorefs

nav:
  - Home: index.md
  - Installation: installation.md
  - Usage:
    - Overview: usage/index.md
    - Image Processing: usage/image_processing.md
    - OMERO: usage/omero.md
    - Jupyter: usage/jupyter.md
  - API Reference:
    - __init__.py: api/init.md
    - imsuite: api/imsuite.md
    - login: api/login.md
    - python_util: api/python_util.md
    - tissuemask: api/tissuemask.md
    - omero:
      - __init__.py: api/omero/init.md
      - files.py: api/omero/files.md
      - helpers.py: api/omero/helpers.md
      - images.py: api/omero/images.md
      - rois.py: api/omero/rois.md
      - tiles.py: api/omero/tiles.md
    - jupyter:
      - __init__.py: api/jupyter/init.md
      - viewers.py: api/jupyter/viewers.md
  - Contributing:
    - Overview: contributing/index.md
    - Implementing the Service Provider: contributing/service_provider.md
    - Expanding Configurations: contributing/configurations.md
    - Adding a New Feature Target: contributing/new_feature.md
    - Adding a New Module: contributing/new_module.md