TaxonoPy/mkdocs.yml at main · Imageomics/TaxonoPy · 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
site_name: TaxonoPy User Guide
site_description: Documentation for the TaxonoPy package

repo_url: https://github.com/Imageomics/taxonopy
repo_name: Imageomics/taxonopy

nav:
  - TaxonoPy:
      - User guide: index.md
      - Quick reference: user-guide/quick-reference.md
      - CLI help reference: command_line_usage/help.md
      - Installation: user-guide/installation.md
      - IO:
          - user-guide/io/index.md
          - Input: user-guide/io/input.md
          - Output: user-guide/io/output.md
          - Cache: user-guide/io/cache.md
      - Development:
          - Contributing:
              - development/contributing/index.md
      - Acknowledgments: acknowledgments.md

theme:
  name: material
  logo: _assets/taxonopy_logo.svg
  favicon: _assets/taxonopy_logo.svg
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: green
    accent: blue
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: green
    accent: blue
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  features:
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.indexes
  - content.code.copy
  - content.code.annotate
  - content.tooltips

extra_css:
- stylesheets/extra.css

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        paths: [src]  # search packages in the src folder
        options:
          docstring_style: google
          merge_init_into_class: true
- gen-files:
    scripts:
      # Generates command_line_usage/help.md from argparse during build.
      - docs/_scripts/gen_cli_help_docs.py
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption:
      types:
        - name: figure-caption
          prefix: ""
        - name: table-caption
          prefix: ""
          classes: "table-caption"
      auto: false
      prepend: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences