mkdocs-common.yml

site_name: Textual

markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - md_in_html
  - admonition
  - def_list
  - meta
  - footnotes

  - toc:
      permalink: true
      baselevel: 1
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: textual
          class: textual
          format: !!python/name:textual._doc.format_svg
        - name: rich
          class: rich
          format: !!python/name:textual._doc.rich
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - markdown.extensions.attr_list
  - pymdownx.details

theme:
  name: material
  custom_dir: docs/custom_theme
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.tabs.sticky
    - navigation.footer
    - content.code.annotate
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode

plugins:
  search:
  autorefs:
  mkdocstrings:
    custom_templates: docs/_templates
    default_handler: python
    handlers:
      python:
        options:
          show_signature_annotations: false
          separate_signature: true
          merge_init_into_class: true
          docstring_options:
            ignore_init_summary: true
          show_source: false
          filters:
            - "!^_"
            - "^__init__$"
            - "!^can_replace$"
            # Hide some methods that Widget subclasses implement but that we don't want
            # to be shown in the docs.
            # This is then overridden in widget.md and app.md so that it shows in the
            # base class.
            - "!^compose$"
            - "!^render$"
            - "!^render_line$"
            - "!^render_lines$"
            - "!^get_content_width$"
            - "!^get_content_height$"
            - "!^compose_add_child$"
    watch:
      - mkdocs-common.yml
      - mkdocs-nav.yml
      - mkdocs-offline.yml
      - mkdocs-online.yml
      - src/textual
  exclude:
    glob:
      - "**/_template.md"
      - "snippets/*"

extra_css:
  - stylesheets/custom.css

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/textualizeio
      name: textualizeio on Twitter
    - icon: fontawesome/brands/github
      link: https://github.com/textualize/textual/
      name: Textual on Github
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Enf6Z3qhVr
      name: Textual Discord server
copyright: Copyright © Textualize, Inc