# Copyright 2026 Google LLC
#
# Licensed 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.
#
# SPDX-License-Identifier: Apache-2.0
site_name: Genkit Endpoints Sample
site_description: Production-ready REST + gRPC endpoints for Genkit AI flows
site_url: ""
repo_url: https://github.com/firebase/genkit
repo_name: firebase/genkit
edit_uri: edit/main/py/samples/web-endpoints-hello/docs/
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep orange
accent: amber
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep orange
accent: amber
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
features:
- content.code.copy
- content.code.annotate
- content.tabs.link
- navigation.instant
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- toc.follow
icon:
repo: fontawesome/brands/github
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
show_source: true
show_root_heading: true
members_order: source
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
nav:
- Home: index.md
- Getting Started:
- Setup: getting-started/setup.md
- Running Locally: getting-started/running.md
- Testing: getting-started/testing.md
- Architecture:
- Overview: architecture/overview.md
- Module Reference: architecture/modules.md
- Dataflow: architecture/dataflow.md
- API Reference:
- Endpoints: api/endpoints.md
- gRPC: api/grpc.md
- Schemas: api/schemas.md
- Deployment:
- Overview: deployment/overview.md
- Containers: deployment/containers.md
- Cloud Platforms: deployment/cloud-platforms.md
- CI/CD: deployment/cicd.md
- Production:
- Performance: production/performance.md
- Security: production/security.md
- Telemetry: production/telemetry.md
- Guides:
- Using as a Template: guides/template.md
- How It Works: guides/how-it-works.md
- Roadmap: roadmap.md
