mkdocs.yml

---
site_name: Ansible Molecule
site_url: https://ansible.readthedocs.io/projects/molecule/
repo_url: https://github.com/ansible/molecule
edit_uri: blob/main/docs/
copyright: Copyright © 2024 Red Hat, Inc.
docs_dir: docs
strict: true

theme:
  name: ansible
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
extra:
  generator: false
  social:
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/molecule/
      name: PyPI
    - icon: fontawesome/solid/scroll
      link: https://github.com/ansible/molecule/releases
      name: Releases
    - icon: simple/mastodon
      link: https://fosstodon.org/@ansible
      name: Mastodon
    - icon: simple/matrix
      link: https://matrix.to/#/#devtools:ansible.com
      name: Matrix
    - icon: fontawesome/brands/discourse
      link: https://forum.ansible.com/c/project/7
      name: Ansible forum
    - icon: fontawesome/brands/github-alt
      link: https://github.com/ansible/molecule

nav:
  - Home: index.md
  - installation.md
  - Using:
      - getting-started.md
      - usage.md
      - next.md
      - configuration.md
      - ci.md
  - Examples:
      - examples/docker.md
      - examples/podman.md
      - examples/kubevirt.md
  - Guides:
      - guides/custom-image.md
      - guides/docker-rootless.md
      - guides/monolith.md
      - guides/inside-a-container.md
      - guides/parallel.md
      - guides/podman-inside-docker.md
      - guides/sharing.md
      - guides/systemd-container.md
  - faq.md
  - contributing.md

plugins:
  - autorefs
  - macros:
      modules: [mkdocs-ansible:mkdocs_ansible]
  - material/search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - material/social
  - material/tags
  - mkdocstrings:
      enable_inventory: true
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            # Sphinx is for historical reasons, but we could consider switching if needed
            # https://mkdocstrings.github.io/griffe/docstrings/
            docstring_style: sphinx
            merge_init_into_class: yes
            show_submodules: yes
          import:
            - url: https://docs.ansible.com/ansible/latest/objects.inv
              domains: [py, std, "std:doc", "std:label"]
            - url: https://pip.pypa.io/en/latest/objects.inv
              domains: [py, std]

markdown_extensions:
  - markdown_include.include:
      base_path: . # CWD (project root)
      throwException: true
  - admonition
  - def_list
  - footnotes
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      social_url_shortener: true
      normalize_issue_symbols: true
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      # reduced to keep TOC nice under Changelog page
      toc_depth: 2
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format