mkdocs.yml

# Project information
site_name: "Flet Charts"
site_url: https://flet-dev.github.io/flet-charts/
site_author: Flet Contributors
site_description: A Flet extension for creating interactive charts and graphs.

# Repository
repo_name: flet-dev/flet-charts
repo_url: https://github.com/flet-dev/flet-charts
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2025 Appveyor Systems Inc.

# Theme
theme:
  name: "material"
  favicon: 'images/favicon.ico'
  logo: 'images/logo.svg'
  icon:
    annotation: material/plus-circle
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme)"
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-auto
        name: "Switch to light mode"
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-7
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-4
        name: "Switch to system preference"
  features:
    - content.action.annotate
    - content.action.copy
    - content.tooltips
    - content.action.tooltips
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    # - navigation.tabs
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.footer
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

extra:
  version:
    provider: mike
  # hide the "Made with Material for MkDocs" message
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/flet-dev
    - icon: fontawesome/brands/discord
      link: https://discord.gg/bCFXYgZR3b
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/fletdev
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/fletdev.bsky.social
extra_css:
  - extras/css/mkdocstrings.css

# Navigation
nav:
  - Getting Started: index.md
  - API Reference:
      - Charts:
        - charts.md
        - BarChart:
          - bar_chart.md
          - BarChartGroup: bar_chart_group.md
          - BarChartRod: bar_chart_rod.md
          - BarChartRodStackItem: bar_chart_rod_stack_item.md
        - LineChart:
          - line_chart.md
          - LineChartData: line_chart_data.md
          - LineChartDataPoint: line_chart_data_point.md
        - MatplotlibChart: matplotlib_chart.md
        - PieChart:
          - pie_chart.md
          - PieChartSection: pie_chart_section.md
        - PlotlyChart: plotly_chart.md
        - ScatterChart:
          - scatter_chart.md
          - ScatterChartSpot: scatter_chart_spot.md
      - Types:
          - ChartAxis: chart_axis.md
          - ChartAxisLabel: chart_axis_label.md
          - ChartPointShape:
              - types/chart_point_shape.md
              - ChartCirclePoint: types/chart_circle_point.md
              - ChartCrossPoint: types/chart_cross_point.md
              - ChartSquarePoint: types/chart_square_point.md
          - ChartGridLines: types/chart_grid_lines.md
          - ChartPointLine: types/chart_point_line.md
          - Events:
            - BarChartEvent: types/bar_chart_event.md
            - ChartEventType: types/chart_event_type.md
            - LineChartEvent: types/line_chart_event.md
            - PieChartEvent: types/pie_chart_event.md
            - ScatterChartEvent: types/scatter_chart_event.md
          - HorizontalAlignment: types/horizontal_alignment.md
          - LineChartEventSpot: types/line_chart_event_spot.md
          - Tooltips:
            - BarChartTooltip: types/bar_chart_tooltip.md
            - BarChartRodTooltip: types/bar_chart_rod_tooltip.md
            - BarChartTooltipDirection: types/bar_chart_tooltip_direction.md
            - ChartDataPointTooltip: types/chart_data_point_tooltip.md
            - LineChartTooltip: types/line_chart_tooltip.md
            - LineChartDataPointTooltip: types/line_chart_data_point_tooltip.md
            - ScatterChartTooltip: types/scatter_chart_tooltip.md
            - ScatterChartSpotTooltip: types/scatter_chart_spot_tooltip.md

  - Changelog: changelog.md
  - License: license.md

# Validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

# Watch
watch:
  - docs
  - src/flet_charts
  - CHANGELOG.md
  - LICENSE
  - README.md

# Plugins
plugins:
  # - footnotes
  - search:
      lang: en
  - macros:
      module_name: docs/extras/macros/__init__
  - open-in-new-tab
  - mike:
      alias_type: symlink
  - glightbox
  - section-index
  - external-images:
      mappings:
        - source_dir: examples
          target_url_path: examples
          include_exts: [ ".png", ".gif", ".svg" ]
  - mkdocstrings:
      default_handler: python_xref
      custom_templates: docs/templates
      handlers:
        python_xref:
          options:
            relative_crossrefs: true
            docstring_style: google
            show_signature_annotations: true
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_root_heading: false
            show_root_toc_entry: false
            show_root_full_path: false
            show_bases: false
            show_source: false
            group_by_category: true
            show_category_heading: true
            show_labels: false
            show_if_no_docstring: true
            docstring_section_style: list
            separate_signature: true
            inherited_members: false
            summary:
                attributes: false
                functions: false
            preload_modules: [ flet ]
            filters:
              - "!^_"   # Exclude private members starting with only one underscore
              - "!(init|before_update)"
            extensions:
              - griffe_modernized_annotations
              - griffe_warnings_deprecated
            extra:
              show_children: false
              show_class_docstring: false
          inventories:
            - url: https://docs.flet.dev/objects.inv
            - url: https://docs.python.org/3/objects.inv
              domains: [ py, std ]
            - url: https://typing-extensions.readthedocs.io/en/latest/objects.inv

# Markdown Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: "#"

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.magiclink:
      repo_url_shorthand: true
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.blocks.caption