mkdocs.yml

# =================================
# Copyright: CEA-LIST/DIASI/SIALV
# Author : pixano@cea.fr
# License: CECILL-C
# =================================

site_name: Pixano Inference Documentation
site_url: https://pixano.github.io/pixano-inference/
theme:
  name: material
  logo: assets/pixano_white.png
  favicon: assets/pixano.png
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: custom
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: custom
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Poppins
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - toc.integrate
repo_url: https://github.com/pixano/pixano-inference
repo_name: pixano/pixano-inference
copyright: Licensed under the CeCILL-C license
extra:
  social:
    - icon: material/email-outline
      link: mailto:pixano@cea.fr
      name: Contact us
    - icon: material/web
      link: https://list.cea.fr/en/
      name: CEA LIST
    - icon: fontawesome/brands/github
      link: https://github.com/pixano/pixano-inference
      name: Pixano on GitHub
  version:
    default: latest
    provider: mike
extra_css:
  - assets/extra.css
plugins:
  - search
  - autorefs
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ""
      canonical_version: latest
      version_selector: true
      css_dir: css
      javascript_dir: js
  - gen-files:
      scripts:
        - ./docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - redirects:
      redirect_maps:
        "index.md": "getting_started/index.md"
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          paths: ["./src/pixano_inference"]
          import:
            - https://docs.python.org/3.12/objects.inv
            - https://numpy.org/doc/1.23/objects.inv
            - https://pandas.pydata.org/pandas-docs/version/1.5/objects.inv
            - https://pillow.readthedocs.io/en/stable/objects.inv
            - https://arrow.apache.org/docs/objects.inv
            - https://docs.pydantic.dev/2.4/objects.inv
            - https://ipython.readthedocs.io/en/8.13.2/objects.inv
            - https://lancedb.github.io/lance/objects.inv
            - https://lancedb.github.io/lancedb/objects.inv
          options:
            docstring_style: google
            docstring_options:
              returns_named_value: false
              ignore_init_summary: yes
            show_submodules: true
            docstring_section_style: table
            members_order: alphabetical
            merge_init_into_class: yes
            show_root_heading: true
            show_source: true
            heading_level: 1
            preload_modules:
              - pydantic

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

nav:
  - "Home": https://pixano.github.io/

  - "Pixano Inference":
      - "API reference": api_reference/
      - "Getting Started": getting_started/