cast-value.py/mkdocs.yml at main · zarr-developers/cast-value.py · 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
site_name: cast-value
site_url: https://cast-value.readthedocs.io/
site_author: "Davis Bennett"

repo_name: "zarr-developers/cast-value.py"
repo_url: "https://github.com/zarr-developers/cast-value.py"

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - search.suggest
    - search.highlight
    - navigation.expand
    - navigation.tracking
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

plugins:
  autorefs: {}
  mkdocstrings:
    handlers:
      python:
        paths: [src]
        inventories:
          - https://docs.python.org/3/objects.inv
        options:
          docstring_style: numpy
          members_order: source
          separate_signature: true
          filters: ["!^_"]
          show_root_heading: true
          show_if_no_docstring: true
          show_signature_annotations: true
          signature_crossrefs: true
          scoped_crossrefs: true
  search: {}

nav:
  - Home: index.md
  - Python API: api.md