numcodecs-replace/mkdocs.yml at main · juntyr/numcodecs-replace · 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
site_name: numcodecs-replace

strict: true

markdown_extensions:
  - footnotes
  - pymdownx.superfences
  - pymdownx.highlight:
      use_pygments: true
      noclasses: true

theme:
  name: readthedocs
  highlightjs: false

nav:
  - Home: index.md
  - Links:
      - GitHub: https://github.com/juntyr/numcodecs-replace
      - PyPI: https://pypi.org/project/numcodecs-replace/

plugins:
  - mkdocstrings-python-generator:
      source_dirs:
        - nav_heading: [Documentation]
          base: src
  - exclude:
      glob:
        - requirements.txt
  - search
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          options:
            docstring_section_style: list
            docstring_style: numpy
            show_if_no_docstring: true
            filters: ["!^_$", "!^_[^_]", "!^__", "__init__"]
            members_order: source
            group_by_category: false
            show_source: false
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            relative_crossrefs: true
            show_root_toc_entry: false
            merge_init_into_class: true
            summary:
              attributes: false
              classes: true
              functions: true
              modules: true
          inventories:
            - https://docs.python.org/3.12/objects.inv
            - https://numpy.org/doc/2.2/objects.inv
            - https://numcodecs.readthedocs.io/en/v0.16.0/objects.inv

watch:
  - src