mkdocs.yml

site_name: Wagtail Live
site_url: https://wagtail.github.io/wagtail-live/
repo_url: https://github.com/wagtail/wagtail-live
repo_name: wagtail/wagtail-live
edit_uri: edit/main/docs/
theme:
  name: 'material'
  icon:
    repo: fontawesome/brands/github
  features:
    - search.suggest
    - search.highlight
  palette:
    primary: 'teal'
    accent: 'indigo'
markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
nav:
  - Home: index.md
  - Getting started:
    - Tutorial: getting_started/tutorial.md
    - Receivers:
      - Set up a local web server with ngrok: getting_started/receivers/setup_ngrok.md
      - Set up Slack Events API receiver: getting_started/receivers/setup_slack.md
      - Set up Telegram webhook receiver: getting_started/receivers/setup_telegram.md
    - Publishers:
      - Set up long polling publisher: getting_started/publishers/setup_long_polling.md
      - Set up interval polling publisher: getting_started/publishers/setup_interval_polling.md
      - Set up Django channels publisher: getting_started/publishers/setup_django_channels.md
      - Set up PieSocket publisher: getting_started/publishers/setup_piesocket.md
      - Set up an event bus based on Redis PubSub: getting_started/publishers/setup_event_bus_redis.md
      - Set up websockets publisher: getting_started/publishers/setup_websockets.md
      - Set up starlette publisher: getting_started/publishers/setup_starlette.md
  - Reference:
      - Settings: reference/settings.md
      - LivePageMixin: reference/live-page-mixin.md
      - Receivers:
        - BaseMessageReceiver: reference/receivers/base-message-receiver.md
        - WebhookReceiverMixin: reference/receivers/webhook_receiver_mixin.md
        - Slack: reference/receivers/slack.md
        - Telegram: reference/receivers/telegram.md
        - Webapp: reference/receivers/webapp.md
      - Publishers:
        - Base Websocket Publisher: reference/publishers/base_websocket_publisher.md
        - Polling publisher mixin: reference/publishers/polling-mixin.md
        - Interval polling: reference/publishers/interval-polling.md
        - Long polling: reference/publishers/long-polling.md
      - Utilities: reference/utils.md
  - Background infromation:
      - Receivers: background-information/input-sources-and-receivers.md
      - Publishers: background-information/publishers.md
  - Development: development.md
  - GSOC report: gsoc_report.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import os
            - import django
            - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")
            - django.setup()