mkdocs.yml

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

site_name: Apache StreamPipes Python
site_description: Python library for Apache StreamPipes
site_author: Apache Software Foundation (ASF)
site_url: https://streampipes.apache.org/docs/docs/python/latest/

repo_name: apache/streampipes
repo_url: https://github.com/apache/streampipes
edit_uri: blob/dev/streampipes-client-python/docs

copyright: "Apache License 2.0"

theme:
  name: material
  logo: https://streampipes.apache.org/img/sp-logo-white-right.png
  favicon: https://streampipes.apache.org/img/favicon.png
  custom_dir: docs/overrides
  features:
    - content.action.edit
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.indexes
    - navigation.tracking
    - search.suggest
  font: false
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/apache/streampipes
  analytics:
    provider: matomo
  homepage: https://streampipes.apache.org/
  version:
    provider: mike

exclude_docs: |
  /scripts/**

# Extensions
markdown_extensions:
  - admonition
  - footnotes
  - toc:
      permalink: true
      toc_depth: "1-3"
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true

plugins:
  - awesome-pages
  - autorefs
  - mkdocs-jupyter
  - gen-files:
      scripts:
        - docs/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            docstring_section_style: spacy
            show_source: False
            merge_init_into_class: true
            inherited_members: true
  - mike:
      canonical_version: "latest"
      version_selector: true
      css_dir: css
      javascript_dir: js
  - search:
      lang:
        - en
  - git-revision-date-localized

extra_css:
  - stylesheets/extra.css

nav:
  - 🏡 Home: index.md
  - 🚀 Getting Started:
      - First Steps: getting-started/first-steps.md
      - Developing & Contributing: getting-started/developing.md
      - Quickstart: getting-started/quickstart.md
  - 🤓 Tutorials:
      - Introduction to the StreamPipes Python Client: tutorials/1-introduction-to-streampipes-python-client.ipynb
      - Extracting Data from the StreamPipes Data Lake: tutorials/2-extracting-data-from-the-streampipes-data-lake.ipynb
      - Exploring Live Data from a StreamPipes Data Stream: tutorials/3-getting-live-data-from-the-streampipes-data-stream.ipynb
      - Using Online Machine Learning on a StreamPipes Data Stream: tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream.ipynb
      - Applying Interoperable Machine Learning in StreamPipes: tutorials/5-applying-interoperable-machine-learning-in-streampipes.ipynb
      - Creating Output Streams with StreamPipes Functions: tutorials/6-streampipes-function-output-stream.ipynb
  - 📚 Reference: reference/*