mkdocs.yml

site_name: python-yaml-ld
site_url: https://python-yaml-ld.iolanta.tech
repo_url: https://github.com/iolanta-tech/python-yaml-ld
edit_uri: edit/master/docs/
repo_name: iolanta-tech/python-yaml-ld
copyright: Copyright © 2024 iolanta.tech

markdown_extensions:
  - pymdownx.snippets
  - admonition
  - codehilite
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg


plugins:
  - search
  - awesome-pages
  - blogging:
      dirs:
        - blog
      features:
        tags: {}
      time_format: '%d %b %Y'  # The format used to display the time
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [python-yaml-ld]
          load_external_modules: true
          options:
            docstring_style: null
            docstring_section_style: spacy

            unwrap_annotated: true
            heading_level: 1
            show_root_heading: true
            parameter_headings: true
            show_source: false
            show_symbol_type_heading: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            allow_inspection: true
            show_if_no_docstring: true
            inherited_members: true
            filters:
              - "!model_config"

  - macros:
      on_error_fail: true

theme:
  name: material
  palette:
    primary: orange
  custom_dir: overrides
  features:
    # - navigation.sections
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.annotate
    - content.action.edit