mkdocs.yml

site_name: python-cqrs
# Деплой на Timeweb: https://mkdocs.python-cqrs.dev/ ; для GitHub Pages CI подставляет свой URL
site_url: https://mkdocs.python-cqrs.dev/
site_description: Документация по библиотеке python-cqrs. Паттерны CQRS, Saga, Mediator и Event Driven на Python.
site_author: Vadim Kozyrevskii
repo_url: https://github.com/vadikko2/python-cqrs
repo_name: vadikko2/python-cqrs
dev_addr: 127.0.0.1:8000
nav:
  - Home: index.md
  - Core Concepts:
    - Bootstrap:
      - Overview: bootstrap/index.md
      - Request Mediator: bootstrap/request_mediator.md
      - Streaming Mediator: bootstrap/streaming_mediator.md
      - Event Mediator: bootstrap/event_mediator.md
      - Saga Mediator: bootstrap/saga_mediator.md
      - Message Brokers: bootstrap/message_brokers.md
      - Middlewares: bootstrap/middlewares.md
      - DI Containers: bootstrap/di_containers.md
      - Advanced: bootstrap/advanced.md
    - Dependency Injection: di.md
    - Commands / Requests Handling:
      - Overview: request_handler/index.md
      - Fallback: request_handler/fallback.md
    - Request / Response Types:
      - Overview: request_response_types/index.md
      - Pydantic: request_response_types/pydantic.md
      - Dataclasses: request_response_types/dataclasses.md
      - Standard Classes: request_response_types/standard_classes.md
      - NamedTuple: request_response_types/namedtuple.md
      - Attrs: request_response_types/attrs.md
      - Msgspec: request_response_types/msgspec.md
      - TypedDict: request_response_types/typeddict.md
      - Mixed Usage: request_response_types/mixed_usage.md
      - Best Practices: request_response_types/best_practices.md
    - Stream Handling:
      - Overview: stream_handling/index.md
      - Configuration: stream_handling/configuration.md
      - FastAPI Integration: stream_handling/fastapi_integration.md
      - Reference: stream_handling/reference.md
      - Fallback: stream_handling/fallback.md
    - Chain of Responsibility:
      - Overview: chain_of_responsibility/index.md
      - Examples: chain_of_responsibility/examples.md
      - Advanced: chain_of_responsibility/advanced.md
      - Fallback: chain_of_responsibility/fallback.md
    - Saga Pattern:
      - Overview: saga/index.md
      - Flow Diagrams: saga/flow.md
      - Storage: saga/storage.md
      - Recovery & Eventual Consistency: saga/recovery.md
      - Compensation Strategy: saga/compensation.md
      - Fallback Pattern:
        - Overview: saga/fallback/index.md
        - Mechanics: saga/fallback/mechanics.md
        - Circuit Breaker: saga/fallback/circuit_breaker.md
        - Examples: saga/fallback/examples.md
      - Examples: saga/examples.md
    - Mermaid Diagrams:
      - Overview: mermaid/index.md
      - Chain of Responsibility: mermaid/chain_of_responsibility.md
      - Saga Pattern: mermaid/saga.md
    - Events Handling:
      - Overview: event_handler/index.md
      - Event Flow: event_handler/event_flow.md
      - Runtime Processing: event_handler/runtime_processing.md
      - Parallel Processing: event_handler/parallel_processing.md
      - Event Types: event_handler/event_types.md
      - Examples: event_handler/examples.md
      - Best Practices: event_handler/best_practices.md
      - Fallback: event_handler/fallback.md
    - Transaction Outbox:
      - Overview: outbox/index.md
      - Implementation: outbox/implementation.md
      - Usage: outbox/usage.md
      - Examples: outbox/examples.md
      - Best Practices: outbox/best_practices.md
  - Integrations:
    - FastAPI Integration: fastapi.md
    - FastStream Integration: faststream.md
    - Event Producing: event_producing.md
    - Protobuf Integration: protobuf.md
theme:
  name: material
  features:
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - navigation.footer
  icon:
    annotation: material/plus-circle
  font:
    text: IBM Plex Sans
  palette:
    - scheme: default
      primary: blue
      accent: blue
markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - codehilite:
      guess_lang: false
  - admonition
  - pymdownx.blocks.caption # Images
  - 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.details
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vadikko2/python-cqrs
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/python-cqrs/
plugins:
  - search
  - awesome-pages
  - autorefs
use_directory_urls: true
strict: true
docs_dir: docs
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/navigation.js
  - javascripts/star-link.js