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/feature-store-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<div class="dropdown"><button class="dropbtn"> API </button> <div id="myDropdown" class="dropdown-content"> <a id="hopsworks_api_link" href="https://docs.hopsworks.ai/hopsworks-api/latest">Hopsworks API</a> <a id="hsfs_api_link" href="https://docs.hopsworks.ai/feature-store-api/latest">Feature Store API</a> <a id="hsfs_javadoc_link" href="https://docs.hopsworks.ai/feature-store-api/latest/javadoc">Feature Store JavaDoc</a> <a id="hsml_api_link" href="https://docs.hopsworks.ai/machine-learning-api/latest">MLOps API</a> </div></div>:
    - Feature Store API Reference:
      - Connection: generated/api/connection_api.md
      - ExpectationSuite: generated/api/expectation_suite_api.md
      - FeatureStore: generated/api/feature_store_api.md
      - FeatureGroup: generated/api/feature_group_api.md
      - ExternalFeatureGroup: generated/api/external_feature_group_api.md
      - SpineGroup: generated/api/spine_group_api.md
      - FeatureView: generated/api/feature_view_api.md
      - TrainingDataset: generated/api/training_dataset_api.md
      - Storage Connector: generated/api/storage_connector_api.md
      - Feature: generated/api/feature_api.md
      - Query: generated/api/query_api.md
      - Transformation Functions: generated/api/transformation_functions_api.md
      - ValidationReport: generated/api/validation_report_api.md
      - Job: generated/api/job.md
      - Provenance Links: generated/api/links.md
      - Statistics:
          - Statistics: generated/api/statistics_api.md
          - Split Statistics: generated/api/split_statistics_api.md
          - Feature descriptive statistics: generated/api/feature_descriptive_statistics_api.md
      - Feature Monitoring:
          - Configuration: generated/api/feature_monitoring_config_api.md
          - Result: generated/api/feature_monitoring_result_api.md
          - Window: generated/api/feature_monitoring_window_config_api.md
      - Embedding:
          - EmbeddingIndex: generated/api/embedding_index_api.md
          - EmbeddingFeature: generated/api/embedding_feature_api.md
          - SimilarityFunctionType: generated/api/similarity_function_type_api.md
    # Added to allow navigation using the side drawer
    - Hopsworks API: https://docs.hopsworks.ai/hopsworks-api/latest/
    - MLOps API: https://docs.hopsworks.ai/machine-learning-api/latest/
    - Feature Store JavaDoc: https://docs.hopsworks.ai/feature-store-javadoc/latest/
    - Contributing: CONTRIBUTING.md
  - Community ↗: https://community.hopsworks.ai/

theme:
  name: material
  custom_dir: docs/overrides
  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
    scheme: hopsworks
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes

extra:
  analytics:
    provider: google
    property: G-64FEEXPSDN
  generator: false
  version:
    - provider: mike
    - default: latest
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/logicalclocks
    - 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/logicalclocks/

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
    - js/dropdown.js

plugins:
    - search
    - minify:
        minify_html: true
        minify_css: true
        minify_js: true
    - mike:
        canonical_version: latest

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