site_name: kiara.documentation
repo_url: https://github.com/DHARPA-Project/kiara.documentation
site_author: Markus Binsteiner
docs_dir: docs
site_dir: build/site

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking

extra_css:
  - stylesheets/extra.css

markdown_extensions:
- attr_list
- admonition
- codehilite:
    guess_lang: false
- toc:
    permalink: true
- pymdownx.snippets:
    base_path: docs
- pymdownx.highlight
- pymdownx.superfences

extra:
  version:
    provider: mike

plugins:
- search
- autorefs
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        path: [src]
        options:
          heading_level: 2
          show_category_heading: true
          members_order: source
          show_submodules: false
          docstring_style: google
          show_if_no_docstring: true
          show_signature_annotations: true
          separate_signature: false
          filters:
            - "!^_"  # exlude all members starting with _
            - "^_config_cls"
        import:
        - https://dharpa.org/kiara/latest/objects.inv
        - https://dharpa.org/kiara_plugin.core_types/latest/objects.inv
        - https://dharpa.org/kiara_plugin.tabular/latest/objects.inv
    watch:
      - "src"
    enable_inventory: true

- macros:
   modules:
     - kiara.doc.mkdocs_macros_cli
     - kiara.doc.mkdocs_macros_kiara

- gen-files:
    scripts:
      - scripts/documentation/gen_info_pages.py
      - scripts/documentation/gen_api_doc_pages.py

- literate-nav:
    nav_file: SUMMARY.md
- section-index