mkdocs/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: PyIceberg
site_url: https://py.iceberg.apache.org/
repo_url: "https://github.com/apache/iceberg-python"
repo_name: "apache/iceberg-python"

plugins:
  - gen-files:
      scripts:
        - gen_doc_stubs.py
  - literate-nav:
      nav_file: SUMMARY.md
  - search
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [..]

theme:
  name: material
  custom_dir: overrides
  logo: assets/images/iceberg-logo-icon.png
  favicon: assets/images/iceberg-logo-icon.png
  font:
    text: Lato
  features:
    - navigation.top
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy  # Enables the copy button
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
        # Mermaid diagrams
        #   Needed so that Superfences doesn't break Mermaid
        #   See: https://facelessuser.github.io/pymdown-extensions/extras/mermaid/#using-in-mkdocs
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  - toc:
      permalink: true