mkdocs.yml

site_name: MkNodes
site_description: "Don´t write docs. Code them."
repo_url: "https://github.com/phil65/mknodes/"
site_url: https://phil65.github.io/mknodes/
site_author: Philipp Temminghoff
copyright: Copyright © 2024 Philipp Temminghoff

theme:
    name: material
    custom_dir: overrides
    icon:
        logo: material/graph-outline
    palette:
        # Palette toggle for automatic mode
        - media: "(prefers-color-scheme)"
          toggle:
              icon: material/brightness-auto
              name: Switch to light mode

        # Palette toggle for light mode
        - media: "(prefers-color-scheme: light)"
          scheme: default
          primary: orange
          toggle:
              icon: material/brightness-7
              name: Switch to dark mode

        # Palette toggle for dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          primary: orange
          toggle:
              icon: material/brightness-4
              name: Switch to system preference
    features:
        - announce.dismiss
        - content.action.edit
        - content.code.copy
        - content.code.select
        - content.code.annotate
        - content.tooltips
        # - content.tabs.link
        - navigation.tracking # update URL based on current item in TOC
        - navigation.path # shows breadcrumbs
        - navigation.tabs # make top level tabs
        - navigation.prune
        - navigation.indexes # documents can be directly attached to sections (overview pages)
        - navigation.footer # next/previous page buttons in footer
        - navigation.top # adds back-to-top button
        # - navigation.sections # top-level sections are rendered as groups
        # - navigation.expand # expand all subsections in left sidebar by defuault
        # - navigation.tabs.sticky # and make them sticky
        - toc.follow # makes toc follow scrolling
        # - toc.integrate  # integrates toc into left menu
        - search.highlight
        - search.suggest
    # - search.share

plugins:
    - search
    - social:
          enabled: !ENV [CI, false]
    - tags
    - markdown-exec
    - mknodes:
          build_fn: mknodes.manual.root:Build.build
          show_page_info: !ENV [CI, false]
          global_resources: false
          render_by_default: false
    - mkdocstrings:
          default_handler: python
          handlers:
              python:
                  import:
                      - url: https://docs.python.org/3/objects.inv
                        domains: [std, py]
                      - url: https://phil65.github.io/jinjarope/objects.inv
                        domains: [std, py]
                      - url: https://phil65.github.io/mkdocs-mknodes/objects.inv
                        domains: [std, py]
                  options:
                      # https://mkdocstrings.github.io/python/usage/
                      show_docstring_returns: false
                      show_source: false
                      show_signature_annotations: true
                      show_symbol_type_toc: true
                      show_symbol_type_heading: true
                      # merge_init_into_class: true
                      ignore_init_summary: true
                      inherited_members: false
                      signature_crossrefs: true
                      separate_signature: true
                      enable_inventory: !ENV [CI, false]
                      line_length: 90

markdown_extensions:
    - attr_list
    - pymdownx.emoji
    - pymdownx.superfences # required for markdown-exec since it checks for it in on_config
    - toc:
          permalink: true
# extra:
#   social:
# - icon: fontawesome/brands/github
#   link: https://github.com/phil65
# - icon: fontawesome/brands/gitter
#   link: https://matrix.to/#/#mknodes:gitter.im
# - icon: fontawesome/brands/python
#   link: https://pypi.org/project/mknodes/
# generator: false disable "made with Material"
# version:  # multiple doc versions
#   provider: mike