Skip to content
Snippets Groups Projects
mkdocs.yml 3.54 KiB
site_name: DAN library
site_dir: public

theme:
  name: material

  # Branding
  logo: assets/logo.png
  favicon: assets/favicon.png

  font:
    text: Roboto
    code: Roboto Mono

  features:
  - navigation.top
  - navigation.tracking
  - navigation.indexes

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
- search
- autorefs
- mkdocstrings:
    handlers:
      python:
        options:
          show_root_toc_entry: false
          show_object_full_path: false
          show_root_heading: yes
          show_source: true
          docstring_style: sphinx
          merge_init_into_class: yes
          show_category_heading: yes
          separate_signature: yes
          members_order: source
          show_if_no_docstring: true

nav:
  - Home: index.md
  - Original implementation: original_paper.md
  - Usage:
    - usage/index.md
    - Datasets:
      - usage/datasets/index.md
      - Dataset extraction: usage/datasets/extract.md
      - Dataset formatting: usage/datasets/format.md
    - Training: usage/train.md
    - Generate: usage/generate.md
    - Predict: usage/predict.md
  - Documentation development: dev/build_docs.md
  - Python Reference:
    - Datasets:
      - ref/datasets/index.md
      - Utils: ref/datasets/utils.md
      - Extraction: