mkdocs.yml

site_name: Lighter
theme:
  custom_dir: docs/overrides
  icon:
    repo: fontawesome/brands/github
  font:
    code: Roboto Mono
  name: material
  favicon: assets/images/lighter_favicon.png
  logo: assets/images/lighter_logo.png
  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - header.autohide
    - content.tooltips
    - footnotes
    - navigation.tabs
    - navigation.tabs.sticky

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

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system preference

extra_css:
  - assets/extra.css

# Plugins
# Auto API reference generation: https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
plugins:
  - search
  - autorefs
  - gen-files:
      scripts:
      - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          docstring_style: google
          options:
            # Removed the default filter that excludes private members (that is, members whose names start with a single underscore).
            filters: null

nav:
  - Home: index.md
  - Basics:
    - Quickstart: basics/quickstart.md
    - Configuration System: basics/config.md
    - Running workflows: basics/workflows.md
    - Integrating your projects: basics/projects.md

  - Advanced:
    - Postprocessing: advanced/postprocessing.md
    - Inferer: advanced/inferer.md
    - Callbacks: advanced/callbacks.md
  - API Reference: reference/
  
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html      
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true  
  - admonition
  - pymdownx.details
  - pymdownx.superfences      

repo_name: project-lighter/lighter
repo_url: https://github.com/project-lighter/lighter