mkdocs.yml

site_name: "Hopsworks Documentation"
site_description: "Official documentation for Hopsworks and its Feature Store - an open source data-intensive AI platform used for the development and operation of machine learning models at scale."
site_author: "Logical Clocks"
site_url: "https://docs.hopsworks.ai/machine-learning-api/latest"

# Repository
repo_name: logicalclocks/hopsworks
repo_url: https://github.com/logicalclocks/hopsworks
edit_uri: ""

nav:
  - Home: https://docs.hopsworks.ai/
  - Getting Started ↗: https://docs.hopsworks.ai/
  - Tutorials: https://docs.hopsworks.ai/
  - Concepts: https://docs.hopsworks.ai/
  - Guides: https://docs.hopsworks.ai/
  - Setup and Installation: https://docs.hopsworks.ai/
  - Administration: https://docs.hopsworks.ai/
  - API:
    - API Reference:
      - Connection: generated/connection_api.md
      - Model Registry:
        - Model Registry: generated/model-registry/model_registry_api.md
        - Model: generated/model-registry/model_api.md
        - Model Schema: generated/model-registry/model_schema_api.md
      - Model Serving:
        - Model Serving: generated/model-serving/model_serving_api.md
        - Deployment: generated/model-serving/deployment_api.md
        - Deployment state: generated/model-serving/predictor_state_api.md
        - Deployment state condition: generated/model-serving/predictor_state_condition_api.md
        - Predictor: generated/model-serving/predictor_api.md
        - Transformer: generated/model-serving/transformer_api.md
        - Inference Logger: generated/model-serving/inference_logger_api.md
        - Inference Batcher: generated/model-serving/inference_batcher_api.md
        - Resources: generated/model-serving/resources_api.md
      - Contributing: CONTRIBUTING.md
  - Community ↗: https://community.hopsworks.ai/

theme:
  name: material
  favicon: assets/images/favicon.ico
  logo: assets/images/hops-logo.png
  icon:
    repo: fontawesome/brands/github
  font:
    text: "Roboto"
    code: "IBM Plex Mono"
  palette:
    accent: teal
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
  custom_dir: docs/overrides

extra:
  analytics:
    provider: google
    property: G-64FEEXPSDN
  generator: false
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/hopsworks
    - icon: fontawesome/brands/github
      link: https://github.com/logicalclocks/hopsworks
    - icon: fontawesome/brands/discourse
      link: https://community.hopsworks.ai/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/hopsworks/

extra_css:
  - css/custom.css
  - css/version-select.css
  - css/dropdown.css
  - css/marctech.css

extra_javascript:
  - js/version-select.js
  - js/inject-api-links.js

plugins:
  - search

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.critic
  - attr_list
  - md_in_html
  - toc:
      permalink: "#"
  - pymdownx.tasklist:
      custom_checkbox: true
  - markdown_include.include:
      base_path: docs