mkdocs.yml

dev_addr: 127.0.0.1:9000
docs_dir: docs/src
edit_uri: "/tree/develop/docs/source"
repo_url: https://github.com/saxix/django-admin-extra-buttons
site_description: ""
site_dir: ./~build/docs
site_name: Documentation
site_url: https://github.com/saxix/django-admin-extra-buttons
strict: false

exclude_docs: |
    _docs/*
    _hooks/*
    _includes/*
    _scripts/*
    ~*

markdown_extensions:
#    - abbr
    - admonition
    - attr_list
    - md_in_html
#    - pymdownx.blocks.caption
#    - pymdownx.details
#    - pymdownx.snippets
    - pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
#    - tables
#    -   pymdownx.tasklist:
#            custom_checkbox: true
#            clickable_checkbox: true
    -   pymdownx.emoji:
            emoji_index: !!python/name:material.extensions.emoji.twemoji
            emoji_generator: !!python/name:material.extensions.emoji.to_svg
#    -   pymdownx.highlight:
#            anchor_linenums: true
#            line_spans: __span
#            pygments_lang_class: true
#    - pymdownx.inlinehilite
#    - pymdownx.magiclink
#  - pymdownx.superfences:
#      custom_fences:
#        - name: mermaid
#          class: mermaid
#          format: !!python/name:pymdownx.superfences.fence_code_format
#
theme:
    name: "material"
    highlightjs: true
    hljs_languages:
        - yaml
        - django
    palette:
        -   scheme: default
            toggle:
                icon: material/brightness-7
                name: Switch to dark mode
                accent: indigo

        -   scheme: slate
            toggle:
                icon: material/brightness-4
                name: Switch to light mode
    features:
        #    - content.action.edit
        - content.code.annotate
        - content.code.copy
        - content.tooltips
        - header.autohidex
        - navigation.indexes
        - navigation.instant
        - navigation.instant.prefetch
        - navigation.instant.progress
validation:
    links:
        absolute_links: relative_to_docs

plugins:
    - awesome-pages
    - autorefs
    - include-markdown
    - macros
    - glightbox
#    - tags
#    - markdownextradata
    -   ezlinks:
            wikilinks: true
    -   mkdocstrings:
            default_handler: python
            handlers:
                  python:
                    options:
#                      summary:
#                        attributes: false
#                        functions: true
#                        modules: false
                      heading_level: 2
                      show_signature: true
                      separate_signature: true
                      show_signature_annotations: true
                      show_root_heading: true
                      show_object_full_path: false
                      show_category_heading: true
                      parameter_headings: true
                      members: false
#                      members_order: alphabetical
                      show_submodules: true
                    inventories:
                        - https://installer.readthedocs.io/en/stable/objects.inv
                        - https://django.readthedocs.org/en/5.1.x/objects.inv
#                        #            - url: https://docs.python.org/3.13/objects.inv
#                        #              domains: [std, py, csv]
                        - https://docs.python.org/3.13/objects.inv
#
    - search
#  - gen-files:
#      scripts:
#        - docs/_scripts/get_settings.py
watch:
    - src/
hooks:
    - docs/_hooks/hooks.py
    - docs/_hooks/version.py
#    - docs/_hooks/shortcodes.py

extra:
    interwiki:
        github: https://github.com/saxix/django-admin-extra-buttons/issues/
        stackoverflow: stackoverflow.com/questions/
        google: https://www.google.com/search?q=
    app: django-adminactions