mkdocs.yml

site_name: numcodecs-wasm

strict: true

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

extra_javascript:
  - js/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

theme:
  name: readthedocs
  highlightjs: false

nav:
  - Home: index.md
  - Documentation: api/
  - Links:
      - GitHub: https://github.com/juntyr/numcodecs-rs
      - PyPI: https://pypi.org/project/numcodecs-wasm/

plugins:
  - gen-files:
      scripts:
        - docs/generate_api.py
  - literate-nav:
      nav_file: SUMMARY.md
  - exclude:
      glob:
        - rs/katex.html
        - generate_api.py
        - requirements.txt
  - search
  - autorefs
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          options:
              docstring_section_style: list
              docstring_style: numpy
              show_if_no_docstring: true
              filters: [
                "!^_$", "!^_[^_]", "!^__", "__init__",
                "!observe_encode", "!observe_decode",
              ]
              members_order: source
              group_by_category: false
              show_source: false
              separate_signature: true
              show_signature_annotations: true
              signature_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://numcodecs.readthedocs.io/en/v0.15.0/objects.inv
            - https://numcodecs-observers.readthedocs.io/en/v0.1.1/objects.inv