mkdocs.yml

site_name: RUL Datasets
site_url: https://krokotsch.eu/rul-datasets
repo_name: tilman151/rul_datasets
repo_url: https://github.com/tilman151/rul-datasets

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: amber
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  features:
    - content.code.annotate

nav:
  - Introduction: index.md
  - Use Cases:
      - Libraries: use_cases/libraries.md
      - Learning Tasks: use_cases/tasks.md
      - Feature Extraction: use_cases/feature_extraction.md
      - Dummy Dataset: dummy_for_debugging.ipynb
  - API Reference: api/

markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

watch: [rul_datasets]

plugins:
  - search
  - autorefs
  - section-index
  - mkdocs-jupyter:
      no_input: False
  - gen-files:
      scripts: [docs/gen_ref_pages.py]
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
            - https://pytorch-lightning.readthedocs.io/en/stable/objects.inv
            - https://pytorch.org/docs/stable/objects.inv
            - https://scikit-learn.org/stable/objects.inv
            - https://numpy.org/doc/stable/objects.inv
          options:
            show_source: false