/
mkdocs.yml
136 lines (132 loc) · 3.58 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
---
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/solid/comments
link: https://github.com/ansible/molecule/discussions
name: Discussions
- 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: docs
- 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