#
# 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 Client
repo_url: https://github.com/apache/streampipes
edit_uri: "https://github.com/apache/streampipes"

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/favicon.png
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.instant
    - navigation.indexes
    - navigation.tracking

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/apache/streampipes

# 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
  - 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

extra_css:
  - stylesheets/extra.css

nav:
    - Home: index.md
    - Getting Started:
        - Installation: getting-started/installation.md
        - Quickstart: getting-started/quickstart.md
    - Reference: reference/*