mkdocs.yml

site_name: dicomtrolley
nav:
- Docs:
  - Home: index.md
  - Usage: usage.md
  - Concepts:  concepts.md
  - Authentication: authentication.md
  - Contributing: contributing.md
- API Reference: reference/dicomtrolley/*

theme: material
plugins:
- search  # Search bar
- autorefs  # Links some class reference to API pages
- gen-files:
    scripts:
      - docs/gen_pages.py  # create API reference on the fly
- literate-nav # Allows md index generated by gen_pages.py to be used as section
- section-index
- mkdocstrings:
    default_handler: python
markdown_extensions:
  - toc:
      permalink: true # Add anchor links next to each heading (why is this not default?)
  - mdantic: # Allows printing pydantic model parameter lists
      columns: ["key", "type", "required", "default"]
  - admonition  # Allows using note, warning, info boxes
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format