diff options
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..0eca7b4 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,90 @@ +--- +site_name: Ansible Compat Library +site_url: https://ansible-compat.readthedocs.io/ +repo_url: https://github.com/ansible/ansible-compat +edit_uri: blob/main/docs/ +copyright: Copyright © 2023 Red Hat, Inc. +docs_dir: docs +# strict: true +watch: + - mkdocs.yml + - src + - docs + +theme: + name: ansible + features: + - content.code.copy + - content.action.edit + - navigation.expand + - navigation.sections + - navigation.instant + - navigation.indexes + - navigation.tracking + - toc.integrate +extra: + social: + - icon: fontawesome/brands/github-alt + link: https://github.com/ansible/ansible-compat +nav: + - examples: index.md + - api: api.md +plugins: + - autorefs + - search + - material/social + - material/tags + - mkdocstrings: + handlers: + python: + import: + - https://docs.python.org/3/objects.inv + options: + # heading_level: 2 + docstring_style: sphinx + docstring_options: + ignore_init_summary: yes + + show_submodules: no + docstring_section_style: list + members_order: alphabetical + show_category_heading: no + # cannot merge init into class due to parse error... + # merge_init_into_class: yes + # separate_signature: yes + show_root_heading: yes + show_signature_annotations: yes + separate_signature: yes + # show_bases: false + # options: + # show_root_heading: true + # docstring_style: sphinx + +markdown_extensions: + - markdown_include.include: + base_path: docs + - admonition + - def_list + - footnotes + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.superfences + - pymdownx.magiclink: + repo_url_shortener: true + repo_url_shorthand: true + social_url_shorthand: true + social_url_shortener: true + user: facelessuser + repo: pymdown-extensions + normalize_issue_symbols: true + - pymdownx.tabbed: + alternate_style: true + - toc: + toc_depth: 2 + permalink: true + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format |