mkdocs.yml

site_name: Graphics Server Protocol
site_description: "GSP: A high-performance graphics server protocol for efficient rendering and visualization."
site_author: GSP Team
repo_name: vispy/GSP_API
repo_url: https://github.com/vispy/GSP_API
edit_uri: edit/main/mkdocs_source/
site_dir: mkdocs_build

docs_dir: mkdocs_source

exclude_docs: |
  /about.md
  /protocol.md
  /conformance.md
  /gallery.md
  /review-examples.md
  /s023_visual_qa.md
  /philosophy/
  /api/gsp.md
  /api/gsp_datoviz.md
  /api/gsp_extra.md
  /api/gsp_matplotlib.md
  /api/gsp_network.md
  /api/gsp_pydantic.md
  /api/vispy_2.md

theme:
  name: material
  font: false
  features:
    - navigation.footer
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - navigation.top
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - tables
  - fenced_code
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: .
      check_paths: true

plugins:
  - search
  - redirects:
      redirect_maps:
        about.md: getting-started/what-is-gsp.md
        protocol.md: specification/index.md
        conformance.md: specification/registries.md
        gallery.md: examples/index.md
        api/gsp.md: api/index.md
        api/gsp_matplotlib.md: support/feature-matrix.md
        api/gsp_datoviz.md: support/feature-matrix.md
        api/vispy_2.md: api/producer.md
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_root_heading: true
            show_source: true
            show_signature_annotations: true
            annotations_path: full
            napoleon_google_docstring: true
            napoleon_numpy_docstring: true

extra:
  generator: false

extra_css:
  - stylesheets/gallery.css
  - stylesheets/site.css

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
      - What is GSP?: getting-started/what-is-gsp.md
      - Install from source: getting-started/installation.md
      - First scene: getting-started/first-scene.md
      - Choose a backend: getting-started/backends.md
  - Concepts:
      - Architecture and roles: concepts/architecture.md
      - Scene model: concepts/scene-model.md
      - Capabilities and adaptation: concepts/capabilities.md
      - Queries and diagnostics: concepts/queries.md
  - User Guide: guide/index.md
  - Backend Support:
      - Reading support tables: support/index.md
      - Feature matrix: support/feature-matrix.md
  - Project Status: status.md
  - Specification:
      - Overview: specification/index.md
      - Protocol lifecycle: specification/protocol.md
      - Scene model: specification/scene.md
      - Resources and data: specification/resources.md
      - Visual semantics: specification/visuals.md
      - Views, transforms, and layout: specification/views-layout.md
      - Capabilities and diagnostics: specification/capabilities.md
      - Queries and readback: specification/queries.md
      - Transports and extensions: specification/transports-extensions.md
      - Backend profiles: specification/backend-profiles.md
      - Normative registries: specification/registries.md
  - Python API:
      - Overview: api/index.md
      - Producer: api/producer.md
      - Lifecycle and transport: api/lifecycle.md
      - Scene, resources, and visuals: api/scene-records.md
      - Queries and diagnostics: api/queries-diagnostics.md
  - Examples:
      - Example index: examples/index.md
      - Backend comparisons: comparisons/index.md
      - Screenshot provenance: comparisons/provenance.md
  - Contributing: contributing.md
  - Development History:
      - Boundary: development-history/index.md
      - Migrate to 0.2: development-history/migration-0.2.md