├── .flake8 ├── .git-blame-ignore-revs ├── .github ├── dependabot.yml ├── patchback.yml └── workflows │ ├── antsibull-docs.yml │ ├── build-css.yml │ └── nox.yml ├── .gitignore ├── .pylintrc.automated ├── .readthedocs.yml ├── .reuse └── dep5 ├── CHANGELOG.md ├── CHANGELOG.md.license ├── CHANGELOG.rst ├── CHANGELOG.rst.license ├── LICENSE ├── LICENSES ├── BSD-2-Clause.txt └── GPL-3.0-or-later.txt ├── README.md ├── antsibull-docs.cfg ├── changelogs ├── changelog.yaml ├── changelog.yaml.license ├── config.yaml └── fragments │ ├── .keep │ └── 371-removal-hint.yml ├── codecov.yml ├── docs-requirements.txt ├── docs ├── changelog.md ├── changelog.md.license ├── collection-docs.md ├── community.md ├── index.md ├── package-docs.md └── schemas.rst ├── mkdocs.yml ├── noxfile.py ├── pyproject.toml ├── src ├── antsibull_docs │ ├── __init__.py │ ├── app_context.py │ ├── augment_docs.py │ ├── cli │ │ ├── __init__.py │ │ ├── antsibull_docs.py │ │ └── doc_commands │ │ │ ├── __init__.py │ │ │ ├── _build.py │ │ │ ├── collection.py │ │ │ ├── collection_plugins.py │ │ │ ├── current.py │ │ │ ├── devel.py │ │ │ ├── lint_docs.py │ │ │ ├── plugin.py │ │ │ ├── sphinx_init.py │ │ │ └── stable.py │ ├── collection_config.py │ ├── collection_links.py │ ├── constants.py │ ├── data │ │ ├── __init__.py │ │ ├── ansible_2_10_routing.yml │ │ ├── docsite │ │ │ ├── __init__.py │ │ │ ├── ansible-docsite │ │ │ │ ├── collection-tombstone.rst.j2 │ │ │ │ ├── list_of_callback_plugins.rst.j2 │ │ │ │ ├── list_of_collections.rst.j2 │ │ │ │ ├── list_of_collections_by_namespace.rst.j2 │ │ │ │ ├── list_of_env_variables.rst.j2 │ │ │ │ ├── list_of_plugins.rst.j2 │ │ │ │ ├── macros │ │ │ │ │ ├── attributes.rst.j2 │ │ │ │ │ ├── choiceslist.rst.j2 │ │ │ │ │ ├── collection_links.rst.j2 │ │ │ │ │ ├── deprecates.rst.j2 │ │ │ │ │ ├── parameters.rst.j2 │ │ │ │ │ ├── returnvalues.rst.j2 │ │ │ │ │ └── version_added.rst.j2 │ │ │ │ ├── plugin-deprecation.rst.j2 │ │ │ │ ├── plugin-error.rst.j2 │ │ │ │ ├── plugin-redirect.rst.j2 │ │ │ │ ├── plugin-tombstone.rst.j2 │ │ │ │ ├── plugin.rst.j2 │ │ │ │ ├── plugins_by_collection.rst.j2 │ │ │ │ └── role.rst.j2 │ │ │ └── simplified-rst │ │ │ │ ├── collection-tombstone.rst.j2 │ │ │ │ ├── list_of_callback_plugins.rst.j2 │ │ │ │ ├── list_of_collections.rst.j2 │ │ │ │ ├── list_of_collections_by_namespace.rst.j2 │ │ │ │ ├── list_of_plugins.rst.j2 │ │ │ │ ├── macros │ │ │ │ ├── attributes.rst.j2 │ │ │ │ ├── choiceslist.rst.j2 │ │ │ │ ├── collection_links.rst.j2 │ │ │ │ ├── deprecates.rst.j2 │ │ │ │ ├── parameters.rst.j2 │ │ │ │ ├── returnvalues.rst.j2 │ │ │ │ └── version_added.rst.j2 │ │ │ │ ├── plugin-deprecation.rst.j2 │ │ │ │ ├── plugin-error.rst.j2 │ │ │ │ ├── plugin-redirect.rst.j2 │ │ │ │ ├── plugin-tombstone.rst.j2 │ │ │ │ ├── plugin.rst.j2 │ │ │ │ ├── plugins_by_collection.rst.j2 │ │ │ │ └── role.rst.j2 │ │ └── sphinx_init │ │ │ ├── _gitignore.j2 │ │ │ ├── antsibull-docs_cfg.j2 │ │ │ ├── build_sh.j2 │ │ │ ├── conf_py.j2 │ │ │ ├── requirements_txt.j2 │ │ │ └── rst_index_rst.j2 │ ├── docs_parsing │ │ ├── __init__.py │ │ ├── ansible_doc.py │ │ ├── ansible_doc_core_213.py │ │ ├── fqcn.py │ │ ├── parsing.py │ │ └── routing.py │ ├── env_variables.py │ ├── extra_docs.py │ ├── jinja2 │ │ ├── __init__.py │ │ ├── environment.py │ │ ├── filters.py │ │ └── tests.py │ ├── lint_extra_docs.py │ ├── lint_helpers.py │ ├── lint_plugin_docs.py │ ├── markup │ │ ├── __init__.py │ │ ├── _counter.py │ │ ├── htmlify.py │ │ ├── rstify.py │ │ └── semantic_helper.py │ ├── plugin_docs.py │ ├── process_docs.py │ ├── py.typed │ ├── rst_labels.py │ ├── rstcheck.py │ ├── schemas │ │ ├── __init__.py │ │ ├── ansible_doc.py │ │ ├── app_context.py │ │ ├── collection_config.py │ │ ├── collection_links.py │ │ └── docs │ │ │ ├── __init__.py │ │ │ ├── ansible_doc.py │ │ │ ├── base.py │ │ │ ├── callback.py │ │ │ ├── module.py │ │ │ ├── plugin.py │ │ │ ├── positional.py │ │ │ └── role.py │ ├── utils │ │ ├── __init__.py │ │ ├── collection_name_transformer.py │ │ ├── get_pkg_data.py │ │ ├── rst.py │ │ └── text.py │ ├── vendored │ │ └── ansible.py │ └── write_docs │ │ ├── __init__.py │ │ ├── changelog.py │ │ ├── collections.py │ │ ├── hierarchy.py │ │ ├── indexes.py │ │ ├── io.py │ │ ├── plugin_stubs.py │ │ └── plugins.py └── sphinx_antsibull_ext │ ├── __init__.py │ ├── antsibull-minimal.css │ ├── antsibull-minimal.css.license │ ├── antsibull.sty │ ├── assets.py │ ├── colors-default-autodark.css │ ├── colors-default-autodark.css.license │ ├── colors-default-dark.css │ ├── colors-default-dark.css.license │ ├── colors-default.css │ ├── colors-default.css.license │ ├── css │ ├── .gitignore │ ├── antsibull-minimal.scss │ ├── browserslistrc │ ├── build.sh │ ├── colors-default-autodark.scss │ ├── colors-default-dark.scss │ ├── colors-default.scss │ ├── cssnano.config.js │ ├── default-colors-dark.scss │ ├── default-colors-light.scss │ ├── package-lock.json │ ├── package-lock.json.license │ ├── package.json │ └── package.json.license │ ├── directive_helper.py │ ├── directives.py │ ├── nodes.py │ ├── roles.py │ ├── schemas │ ├── __init__.py │ └── ansible_links.py │ └── sphinx_helper.py ├── stubs ├── ansible │ ├── __init__.pyi │ ├── cli │ │ ├── __init__.pyi │ │ └── arguments.pyi │ ├── collections │ │ └── list.pyi │ ├── constants.pyi │ ├── galaxy │ │ └── collection.pyi │ ├── module_utils │ │ ├── _text.pyi │ │ └── common │ │ │ └── json.pyi │ ├── plugins │ │ └── loader.pyi │ ├── release.pyi │ └── utils │ │ ├── collection_loader.pyi │ │ └── plugin_docs.pyi ├── argcomplete.pyi ├── jinja2 │ └── utils.pyi ├── rstcheck.pyi └── rstcheck_core │ ├── __init__.pyi │ ├── checker.pyi │ ├── config.pyi │ └── types.pyi └── tests ├── functional ├── ansible-doc-cache-all-others.json ├── ansible-doc-cache-all-others.json.license ├── ansible-doc-cache-all.json ├── ansible-doc-cache-all.json.license ├── ansible-doc-cache-ansible.builtin-ns.col2-ns2.col.json ├── ansible-doc-cache-ansible.builtin-ns.col2-ns2.col.json.license ├── ansible-doc-cache-ansible.builtin-ns2.col.json ├── ansible-doc-cache-ansible.builtin-ns2.col.json.license ├── ansible-doc-cache-ansible.builtin-ns2.flatcol.json ├── ansible-doc-cache-ansible.builtin-ns2.flatcol.json.license ├── ansible-doc-cache-ns.col1-ns.col2-ns2.col-ns2.flatcol.json ├── ansible-doc-cache-ns.col1-ns.col2-ns2.col-ns2.flatcol.json.license ├── ansible-doc-cache-ns.col1-ns2.col-ns2.flatcol.json ├── ansible-doc-cache-ns.col1-ns2.col-ns2.flatcol.json.license ├── ansible-doc-cache-ns.col2.json ├── ansible-doc-cache-ns.col2.json.license ├── ansible-doc-cache-ns2.col.json ├── ansible-doc-cache-ns2.col.json.license ├── ansible-galaxy-cache-all-others.json ├── ansible-galaxy-cache-all-others.json.license ├── ansible-galaxy-cache-all.json ├── ansible-galaxy-cache-all.json.license ├── ansible-galaxy-cache-ns.col2.json ├── ansible-galaxy-cache-ns.col2.json.license ├── ansible-galaxy-cache-ns2.col.json ├── ansible-galaxy-cache-ns2.col.json.license ├── ansible-version.output ├── ansible-version.output.license ├── ansible_doc_caching.py ├── antsibull-docs-stub.py ├── baseline-default │ └── collections │ │ ├── callback_index_stdout.rst │ │ ├── environment_variables.rst │ │ ├── index.rst │ │ ├── index_become.rst │ │ ├── index_cache.rst │ │ ├── index_callback.rst │ │ ├── index_cliconf.rst │ │ ├── index_connection.rst │ │ ├── index_filter.rst │ │ ├── index_inventory.rst │ │ ├── index_lookup.rst │ │ ├── index_module.rst │ │ ├── index_role.rst │ │ ├── index_shell.rst │ │ ├── index_strategy.rst │ │ ├── index_test.rst │ │ ├── index_vars.rst │ │ ├── ns │ │ ├── col1 │ │ │ ├── changelog.rst │ │ │ └── index.rst │ │ ├── col2 │ │ │ ├── bar_role.rst │ │ │ ├── extra_become.rst │ │ │ ├── extra_cache.rst │ │ │ ├── extra_callback.rst │ │ │ ├── extra_cliconf.rst │ │ │ ├── extra_connection.rst │ │ │ ├── extra_filter.rst │ │ │ ├── extra_inventory.rst │ │ │ ├── extra_lookup.rst │ │ │ ├── extra_module.rst │ │ │ ├── extra_role.rst │ │ │ ├── extra_shell.rst │ │ │ ├── extra_strategy.rst │ │ │ ├── extra_test.rst │ │ │ ├── extra_vars.rst │ │ │ ├── foo2_module.rst │ │ │ ├── foo3_module.rst │ │ │ ├── foo4_module.rst │ │ │ ├── foo_module.rst │ │ │ └── index.rst │ │ └── index.rst │ │ └── ns2 │ │ ├── col │ │ ├── bar_filter.rst │ │ ├── bar_test.rst │ │ ├── changelog.rst │ │ ├── docsite │ │ │ └── filter_guide.rst │ │ ├── foo2_module.rst │ │ ├── foo_1_redirect_module.rst │ │ ├── foo_2_redirect_module.rst │ │ ├── foo_3_redirect_module.rst │ │ ├── foo_4_redirect_module.rst │ │ ├── foo_5_redirect_module.rst │ │ ├── foo_become.rst │ │ ├── foo_cache.rst │ │ ├── foo_callback.rst │ │ ├── foo_cliconf.rst │ │ ├── foo_connection.rst │ │ ├── foo_filter.rst │ │ ├── foo_inventory.rst │ │ ├── foo_lookup.rst │ │ ├── foo_module.rst │ │ ├── foo_redirect_module.rst │ │ ├── foo_role.rst │ │ ├── foo_shell.rst │ │ ├── foo_strategy.rst │ │ ├── foo_test.rst │ │ ├── foo_vars.rst │ │ ├── index.rst │ │ ├── is_bar_test.rst │ │ └── sub.foo3_module.rst │ │ ├── flatcol │ │ ├── foo2_module.rst │ │ ├── foo_module.rst │ │ └── index.rst │ │ └── index.rst ├── baseline-no-breadcrumbs │ └── collections │ │ ├── callback_index_stdout.rst │ │ ├── environment_variables.rst │ │ ├── index.rst │ │ ├── index_become.rst │ │ ├── index_cache.rst │ │ ├── index_callback.rst │ │ ├── index_cliconf.rst │ │ ├── index_connection.rst │ │ ├── index_filter.rst │ │ ├── index_inventory.rst │ │ ├── index_lookup.rst │ │ ├── index_module.rst │ │ ├── index_role.rst │ │ ├── index_shell.rst │ │ ├── index_strategy.rst │ │ ├── index_test.rst │ │ ├── index_vars.rst │ │ ├── ns │ │ ├── col1 │ │ │ ├── changelog.rst │ │ │ └── index.rst │ │ ├── col2 │ │ │ ├── bar_role.rst │ │ │ ├── extra_become.rst │ │ │ ├── extra_cache.rst │ │ │ ├── extra_callback.rst │ │ │ ├── extra_cliconf.rst │ │ │ ├── extra_connection.rst │ │ │ ├── extra_filter.rst │ │ │ ├── extra_inventory.rst │ │ │ ├── extra_lookup.rst │ │ │ ├── extra_module.rst │ │ │ ├── extra_role.rst │ │ │ ├── extra_shell.rst │ │ │ ├── extra_strategy.rst │ │ │ ├── extra_test.rst │ │ │ ├── extra_vars.rst │ │ │ ├── foo2_module.rst │ │ │ ├── foo3_module.rst │ │ │ ├── foo4_module.rst │ │ │ ├── foo_module.rst │ │ │ └── index.rst │ │ └── index.rst │ │ └── ns2 │ │ ├── col │ │ ├── bar_filter.rst │ │ ├── bar_test.rst │ │ ├── changelog.rst │ │ ├── docsite │ │ │ └── filter_guide.rst │ │ ├── foo2_module.rst │ │ ├── foo_1_redirect_module.rst │ │ ├── foo_2_redirect_module.rst │ │ ├── foo_3_redirect_module.rst │ │ ├── foo_4_redirect_module.rst │ │ ├── foo_5_redirect_module.rst │ │ ├── foo_become.rst │ │ ├── foo_cache.rst │ │ ├── foo_callback.rst │ │ ├── foo_cliconf.rst │ │ ├── foo_connection.rst │ │ ├── foo_filter.rst │ │ ├── foo_inventory.rst │ │ ├── foo_lookup.rst │ │ ├── foo_module.rst │ │ ├── foo_redirect_module.rst │ │ ├── foo_role.rst │ │ ├── foo_shell.rst │ │ ├── foo_strategy.rst │ │ ├── foo_test.rst │ │ ├── foo_vars.rst │ │ ├── index.rst │ │ ├── is_bar_test.rst │ │ └── sub.foo3_module.rst │ │ ├── flatcol │ │ ├── foo2_module.rst │ │ ├── foo_module.rst │ │ └── index.rst │ │ └── index.rst ├── baseline-no-indexes │ └── collections │ │ ├── environment_variables.rst │ │ ├── ns │ │ └── col1 │ │ │ ├── changelog.rst │ │ │ └── index.rst │ │ └── ns2 │ │ ├── col │ │ ├── bar_filter.rst │ │ ├── bar_test.rst │ │ ├── changelog.rst │ │ ├── docsite │ │ │ └── filter_guide.rst │ │ ├── foo2_module.rst │ │ ├── foo_1_redirect_module.rst │ │ ├── foo_2_redirect_module.rst │ │ ├── foo_3_redirect_module.rst │ │ ├── foo_4_redirect_module.rst │ │ ├── foo_5_redirect_module.rst │ │ ├── foo_become.rst │ │ ├── foo_cache.rst │ │ ├── foo_callback.rst │ │ ├── foo_cliconf.rst │ │ ├── foo_connection.rst │ │ ├── foo_filter.rst │ │ ├── foo_inventory.rst │ │ ├── foo_lookup.rst │ │ ├── foo_module.rst │ │ ├── foo_redirect_module.rst │ │ ├── foo_role.rst │ │ ├── foo_shell.rst │ │ ├── foo_strategy.rst │ │ ├── foo_test.rst │ │ ├── foo_vars.rst │ │ ├── index.rst │ │ ├── is_bar_test.rst │ │ └── sub.foo3_module.rst │ │ └── flatcol │ │ ├── foo2_module.rst │ │ ├── foo_module.rst │ │ └── index.rst ├── baseline-plugin │ └── ns2.col.foo_lookup.rst ├── baseline-simplified-rst-squash-hierarchy │ ├── bar_filter.rst │ ├── bar_test.rst │ ├── changelog.rst │ ├── docsite │ │ └── filter_guide.rst │ ├── foo2_module.rst │ ├── foo_1_redirect_module.rst │ ├── foo_2_redirect_module.rst │ ├── foo_3_redirect_module.rst │ ├── foo_4_redirect_module.rst │ ├── foo_5_redirect_module.rst │ ├── foo_become.rst │ ├── foo_cache.rst │ ├── foo_callback.rst │ ├── foo_cliconf.rst │ ├── foo_connection.rst │ ├── foo_filter.rst │ ├── foo_inventory.rst │ ├── foo_lookup.rst │ ├── foo_module.rst │ ├── foo_redirect_module.rst │ ├── foo_role.rst │ ├── foo_shell.rst │ ├── foo_strategy.rst │ ├── foo_test.rst │ ├── foo_vars.rst │ ├── index.rst │ ├── is_bar_test.rst │ └── sub.foo3_module.rst ├── baseline-simplified-rst │ └── collections │ │ ├── callback_index_stdout.rst │ │ ├── index.rst │ │ ├── index_become.rst │ │ ├── index_cache.rst │ │ ├── index_callback.rst │ │ ├── index_cliconf.rst │ │ ├── index_connection.rst │ │ ├── index_filter.rst │ │ ├── index_inventory.rst │ │ ├── index_lookup.rst │ │ ├── index_module.rst │ │ ├── index_role.rst │ │ ├── index_shell.rst │ │ ├── index_strategy.rst │ │ ├── index_test.rst │ │ ├── index_vars.rst │ │ ├── ns │ │ ├── col1 │ │ │ ├── changelog.rst │ │ │ └── index.rst │ │ ├── col2 │ │ │ ├── bar_role.rst │ │ │ ├── extra_become.rst │ │ │ ├── extra_cache.rst │ │ │ ├── extra_callback.rst │ │ │ ├── extra_cliconf.rst │ │ │ ├── extra_connection.rst │ │ │ ├── extra_filter.rst │ │ │ ├── extra_inventory.rst │ │ │ ├── extra_lookup.rst │ │ │ ├── extra_module.rst │ │ │ ├── extra_role.rst │ │ │ ├── extra_shell.rst │ │ │ ├── extra_strategy.rst │ │ │ ├── extra_test.rst │ │ │ ├── extra_vars.rst │ │ │ ├── foo2_module.rst │ │ │ ├── foo3_module.rst │ │ │ ├── foo4_module.rst │ │ │ ├── foo_module.rst │ │ │ └── index.rst │ │ └── index.rst │ │ └── ns2 │ │ ├── col │ │ ├── bar_filter.rst │ │ ├── bar_test.rst │ │ ├── changelog.rst │ │ ├── docsite │ │ │ └── filter_guide.rst │ │ ├── foo2_module.rst │ │ ├── foo_1_redirect_module.rst │ │ ├── foo_2_redirect_module.rst │ │ ├── foo_3_redirect_module.rst │ │ ├── foo_4_redirect_module.rst │ │ ├── foo_5_redirect_module.rst │ │ ├── foo_become.rst │ │ ├── foo_cache.rst │ │ ├── foo_callback.rst │ │ ├── foo_cliconf.rst │ │ ├── foo_connection.rst │ │ ├── foo_filter.rst │ │ ├── foo_inventory.rst │ │ ├── foo_lookup.rst │ │ ├── foo_module.rst │ │ ├── foo_redirect_module.rst │ │ ├── foo_role.rst │ │ ├── foo_shell.rst │ │ ├── foo_strategy.rst │ │ ├── foo_test.rst │ │ ├── foo_vars.rst │ │ ├── index.rst │ │ ├── is_bar_test.rst │ │ └── sub.foo3_module.rst │ │ ├── flatcol │ │ ├── foo2_module.rst │ │ ├── foo_module.rst │ │ └── index.rst │ │ └── index.rst ├── baseline-sphinx-init-collections │ ├── .gitignore │ ├── antsibull-docs.cfg │ ├── build.sh │ ├── conf.py │ ├── requirements.txt │ └── rst │ │ └── index.rst ├── baseline-sphinx-init-config │ ├── .gitignore │ ├── antsibull-docs.cfg │ ├── build.sh │ ├── conf.py │ ├── requirements.txt │ └── rst │ │ └── index.rst ├── baseline-sphinx-init-current │ ├── .gitignore │ ├── antsibull-docs.cfg │ ├── build.sh │ ├── conf.py │ ├── requirements.txt │ └── rst │ │ └── index.rst ├── baseline-sphinx-init-extra │ ├── .gitignore │ ├── antsibull-docs.cfg │ ├── build.sh │ ├── conf.py │ ├── requirements.txt │ └── rst │ │ └── index.rst ├── baseline-squash-hierarchy │ ├── bar_filter.rst │ ├── bar_test.rst │ ├── changelog.rst │ ├── docsite │ │ └── filter_guide.rst │ ├── environment_variables.rst │ ├── foo2_module.rst │ ├── foo_1_redirect_module.rst │ ├── foo_2_redirect_module.rst │ ├── foo_3_redirect_module.rst │ ├── foo_4_redirect_module.rst │ ├── foo_5_redirect_module.rst │ ├── foo_become.rst │ ├── foo_cache.rst │ ├── foo_callback.rst │ ├── foo_cliconf.rst │ ├── foo_connection.rst │ ├── foo_filter.rst │ ├── foo_inventory.rst │ ├── foo_lookup.rst │ ├── foo_module.rst │ ├── foo_redirect_module.rst │ ├── foo_role.rst │ ├── foo_shell.rst │ ├── foo_strategy.rst │ ├── foo_test.rst │ ├── foo_vars.rst │ ├── index.rst │ ├── is_bar_test.rst │ └── sub.foo3_module.rst ├── baseline-use-html-blobs │ └── collections │ │ ├── callback_index_stdout.rst │ │ ├── environment_variables.rst │ │ ├── index.rst │ │ ├── index_become.rst │ │ ├── index_cache.rst │ │ ├── index_callback.rst │ │ ├── index_cliconf.rst │ │ ├── index_connection.rst │ │ ├── index_filter.rst │ │ ├── index_inventory.rst │ │ ├── index_lookup.rst │ │ ├── index_module.rst │ │ ├── index_role.rst │ │ ├── index_shell.rst │ │ ├── index_strategy.rst │ │ ├── index_test.rst │ │ ├── index_vars.rst │ │ └── ns2 │ │ ├── col │ │ ├── bar_filter.rst │ │ ├── bar_test.rst │ │ ├── changelog.rst │ │ ├── docsite │ │ │ └── filter_guide.rst │ │ ├── foo2_module.rst │ │ ├── foo_1_redirect_module.rst │ │ ├── foo_2_redirect_module.rst │ │ ├── foo_3_redirect_module.rst │ │ ├── foo_4_redirect_module.rst │ │ ├── foo_5_redirect_module.rst │ │ ├── foo_become.rst │ │ ├── foo_cache.rst │ │ ├── foo_callback.rst │ │ ├── foo_cliconf.rst │ │ ├── foo_connection.rst │ │ ├── foo_filter.rst │ │ ├── foo_inventory.rst │ │ ├── foo_lookup.rst │ │ ├── foo_module.rst │ │ ├── foo_redirect_module.rst │ │ ├── foo_role.rst │ │ ├── foo_shell.rst │ │ ├── foo_strategy.rst │ │ ├── foo_test.rst │ │ ├── foo_vars.rst │ │ ├── index.rst │ │ ├── is_bar_test.rst │ │ └── sub.foo3_module.rst │ │ └── index.rst ├── build-docs-baseline.sh ├── build-sphinx-init-baseline.sh ├── collections │ └── ansible_collections │ │ ├── ns │ │ ├── col1 │ │ │ ├── COPYING │ │ │ ├── changelogs │ │ │ │ └── changelog.yaml │ │ │ ├── docs │ │ │ │ └── docsite │ │ │ │ │ └── config.yml │ │ │ ├── galaxy.yml │ │ │ └── plugins │ │ │ │ └── module_utils │ │ │ │ └── empty.py │ │ └── col2 │ │ │ ├── COPYING │ │ │ ├── changelogs │ │ │ └── changelog.yaml │ │ │ ├── docs │ │ │ └── docsite │ │ │ │ ├── config.yml │ │ │ │ ├── extra-docs.yml │ │ │ │ ├── links.yml │ │ │ │ └── rst │ │ │ │ └── filter_guide.rst │ │ │ ├── galaxy.yml │ │ │ ├── meta │ │ │ └── runtime.yml │ │ │ ├── plugins │ │ │ ├── become │ │ │ │ └── extra.py │ │ │ ├── cache │ │ │ │ └── extra.py │ │ │ ├── callback │ │ │ │ └── extra.py │ │ │ ├── cliconf │ │ │ │ └── extra.py │ │ │ ├── connection │ │ │ │ └── extra.py │ │ │ ├── filter │ │ │ │ └── extra.py │ │ │ ├── inventory │ │ │ │ └── extra.py │ │ │ ├── lookup │ │ │ │ └── extra.py │ │ │ ├── modules │ │ │ │ ├── extra.py │ │ │ │ ├── foo.py │ │ │ │ ├── foo2.py │ │ │ │ ├── foo3.py │ │ │ │ └── foo4.py │ │ │ ├── shell │ │ │ │ └── extra.py │ │ │ ├── strategy │ │ │ │ └── extra.py │ │ │ ├── test │ │ │ │ └── extra.py │ │ │ └── vars │ │ │ │ └── extra.py │ │ │ └── roles │ │ │ ├── bar │ │ │ ├── meta │ │ │ │ ├── argument_specs.yml │ │ │ │ └── main.yml │ │ │ └── tasks │ │ │ │ ├── baz.yml │ │ │ │ └── main.yml │ │ │ └── extra │ │ │ ├── meta │ │ │ ├── argument_specs.yml │ │ │ └── main.yml │ │ │ └── tasks │ │ │ ├── baz.yml │ │ │ └── main.yml │ │ └── ns2 │ │ ├── col │ │ ├── COPYING │ │ ├── changelogs │ │ │ └── changelog.yaml │ │ ├── docs │ │ │ └── docsite │ │ │ │ ├── config.yml │ │ │ │ ├── extra-docs.yml │ │ │ │ ├── links.yml │ │ │ │ └── rst │ │ │ │ └── filter_guide.rst │ │ ├── galaxy.yml │ │ ├── meta │ │ │ └── runtime.yml │ │ ├── plugins │ │ │ ├── become │ │ │ │ └── foo.py │ │ │ ├── cache │ │ │ │ └── foo.py │ │ │ ├── callback │ │ │ │ └── foo.py │ │ │ ├── cliconf │ │ │ │ └── foo.py │ │ │ ├── connection │ │ │ │ └── foo.py │ │ │ ├── filter │ │ │ │ ├── bar.py │ │ │ │ ├── bar.yml │ │ │ │ └── foo.py │ │ │ ├── inventory │ │ │ │ └── foo.py │ │ │ ├── lookup │ │ │ │ └── foo.py │ │ │ ├── modules │ │ │ │ ├── foo.py │ │ │ │ ├── foo2.py │ │ │ │ └── sub │ │ │ │ │ └── foo3.py │ │ │ ├── shell │ │ │ │ └── foo.py │ │ │ ├── strategy │ │ │ │ └── foo.py │ │ │ ├── test │ │ │ │ ├── bar.py │ │ │ │ ├── bar.yml │ │ │ │ ├── foo.py │ │ │ │ └── is_bar.yml │ │ │ └── vars │ │ │ │ └── foo.py │ │ └── roles │ │ │ └── foo │ │ │ ├── meta │ │ │ ├── argument_specs.yml │ │ │ └── main.yml │ │ │ └── tasks │ │ │ └── main.yml │ │ └── flatcol │ │ ├── COPYING │ │ ├── docs │ │ └── docsite │ │ │ ├── config.yml │ │ │ └── links.yml │ │ ├── galaxy.yml │ │ └── plugins │ │ └── modules │ │ ├── foo.py │ │ └── sub │ │ └── foo2.py ├── other-collections │ └── ansible_collections │ │ └── ext │ │ └── col │ │ ├── galaxy.yml │ │ └── plugins │ │ ├── lookup │ │ └── bar.py │ │ └── modules │ │ └── foo.py ├── sanitize-ansible-doc-dump.py ├── sanitize-ansible-galaxy-list.py ├── schema │ ├── good_data │ │ ├── one_become.json │ │ ├── one_become.json.license │ │ ├── one_become_results.json │ │ ├── one_become_results.json.license │ │ ├── one_cache.json │ │ ├── one_cache.json.license │ │ ├── one_cache_results.json │ │ ├── one_cache_results.json.license │ │ ├── one_callback.json │ │ ├── one_callback.json.license │ │ ├── one_callback_results.json │ │ ├── one_callback_results.json.license │ │ ├── one_cliconf.json │ │ ├── one_cliconf.json.license │ │ ├── one_cliconf_results.json │ │ ├── one_cliconf_results.json.license │ │ ├── one_connection.json │ │ ├── one_connection.json.license │ │ ├── one_connection_results.json │ │ ├── one_connection_results.json.license │ │ ├── one_filter.json │ │ ├── one_filter.json.license │ │ ├── one_filter_results.json │ │ ├── one_filter_results.json.license │ │ ├── one_httpapi.json │ │ ├── one_httpapi.json.license │ │ ├── one_httpapi_results.json │ │ ├── one_httpapi_results.json.license │ │ ├── one_inventory.json │ │ ├── one_inventory.json.license │ │ ├── one_inventory_results.json │ │ ├── one_inventory_results.json.license │ │ ├── one_lookup.json │ │ ├── one_lookup.json.license │ │ ├── one_lookup_results.json │ │ ├── one_lookup_results.json.license │ │ ├── one_module.json │ │ ├── one_module.json.license │ │ ├── one_module_results.json │ │ ├── one_module_results.json.license │ │ ├── one_netconf.json │ │ ├── one_netconf.json.license │ │ ├── one_netconf_results.json │ │ ├── one_netconf_results.json.license │ │ ├── one_role.json │ │ ├── one_role.json.license │ │ ├── one_role_results.json │ │ ├── one_role_results.json.license │ │ ├── one_shell.json │ │ ├── one_shell.json.license │ │ ├── one_shell_results.json │ │ ├── one_shell_results.json.license │ │ ├── one_strategy.json │ │ ├── one_strategy.json.license │ │ ├── one_strategy_results.json │ │ ├── one_strategy_results.json.license │ │ ├── one_test.json │ │ ├── one_test.json.license │ │ ├── one_test_results.json │ │ ├── one_test_results.json.license │ │ ├── one_vars.json │ │ ├── one_vars.json.license │ │ ├── one_vars_results.json │ │ ├── one_vars_results.json.license │ │ ├── ssh_connection.json │ │ ├── ssh_connection.json.license │ │ ├── ssh_connection_results.json │ │ └── ssh_connection_results.json.license │ └── test_schema.py ├── test.rst ├── test_docs_baseline.py ├── test_docs_linting.py ├── test_sphinx_init_baseline.py └── utils.py ├── units ├── markup │ ├── test_counter.py │ ├── test_markup.py │ └── test_semantic_helper.py ├── test_jinja2.py └── utils │ └── test_text.py └── validate-html.py /.flake8: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2023 Maxwell G 5 | 6 | [flake8] 7 | extend-ignore = E203 8 | count = true 9 | max-complexity = 10 10 | # black's max-line-length is 89, but it doesn't touch long string literals. 11 | max-line-length = 100 12 | statistics = true 13 | -------------------------------------------------------------------------------- /.git-blame-ignore-revs: -------------------------------------------------------------------------------- 1 | # Format the codebase with black 2 | 6c2ca8acadc5261f1bb975ddc72216315c139c49 3 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "github-actions" 9 | directory: "/" 10 | schedule: 11 | interval: "weekly" 12 | groups: 13 | ci: 14 | patterns: 15 | - "*" 16 | - package-ecosystem: "npm" 17 | directory: "/src/sphinx_antsibull_ext/css/" 18 | schedule: 19 | interval: "weekly" 20 | groups: 21 | npm: 22 | patterns: 23 | - "*" 24 | -------------------------------------------------------------------------------- /.github/patchback.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | backport_branch_prefix: patchback/backports/ 7 | backport_label_prefix: backport- 8 | target_branch_prefix: stable- 9 | ... 10 | -------------------------------------------------------------------------------- /.readthedocs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | version: 2 7 | build: 8 | os: ubuntu-22.04 9 | tools: 10 | python: "3.11" 11 | commands: 12 | - pip install -U nox 13 | - mkdir -p _readthedocs/html/ 14 | - nox -e mkdocs -- build --site-dir=_readthedocs/html 15 | -------------------------------------------------------------------------------- /.reuse/dep5: -------------------------------------------------------------------------------- 1 | Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 2 | 3 | Files: changelogs/fragments/* .git-blame-ignore-revs 4 | Copyright: Ansible Project 5 | License: GPL-3.0-or-later 6 | 7 | Files: tests/functional/baseline-* 8 | Copyright: Ansible Project 9 | License: GPL-3.0-or-later 10 | -------------------------------------------------------------------------------- /CHANGELOG.md.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /CHANGELOG.rst.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /LICENSES/GPL-3.0-or-later.txt: -------------------------------------------------------------------------------- 1 | ../LICENSE -------------------------------------------------------------------------------- /changelogs/changelog.yaml.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /changelogs/fragments/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ansible-community/antsibull-docs/ae2f93e06488daaaa87accc91f468116f6002598/changelogs/fragments/.keep -------------------------------------------------------------------------------- /changelogs/fragments/371-removal-hint.yml: -------------------------------------------------------------------------------- 1 | minor_changes: 2 | - "Extend deprecation/removal note that collections can be installed manually after removal (https://github.com/ansible-community/antsibull-docs/pull/371)." 3 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | github_checks: 7 | annotations: false 8 | 9 | fixes: 10 | - "antsibull-docs/::" 11 | -------------------------------------------------------------------------------- /docs-requirements.txt: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | mkdocs 6 | mkdocs-ansible 7 | -------------------------------------------------------------------------------- /docs/changelog.md.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /src/antsibull_docs/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | """The main antsibull-docs module. Contains versioning information.""" 6 | 7 | __version__ = "2.16.3.post0" 8 | 9 | 10 | __all__ = ("__version__",) 11 | -------------------------------------------------------------------------------- /src/antsibull_docs/app_context.py: -------------------------------------------------------------------------------- 1 | # Author: Felix Fontein 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 3 | # https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | # SPDX-FileCopyrightText: 2022, Ansible Project 6 | """Local app and lib context provider""" 7 | 8 | from __future__ import annotations 9 | 10 | # pylint: disable-next=unused-import 11 | from antsibull_core.app_context import lib_ctx # noqa 12 | from antsibull_core.app_context import AppContextWrapper 13 | 14 | from antsibull_docs.schemas.app_context import DocsAppContext 15 | 16 | app_ctx: AppContextWrapper[DocsAppContext] = AppContextWrapper() 17 | -------------------------------------------------------------------------------- /src/antsibull_docs/cli/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | 6 | """Entrypoints to scripts""" 7 | 8 | from __future__ import annotations 9 | -------------------------------------------------------------------------------- /src/antsibull_docs/cli/doc_commands/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/ansible-docsite/collection-tombstone.rst.j2: -------------------------------------------------------------------------------- 1 | {# 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | #} 6 | 7 | :orphan: 8 | 9 | {% if antsibull_docs_version %} 10 | .. meta:: 11 | :antsibull-docs: @{ antsibull_docs_version }@ 12 | 13 | {% endif %} 14 | 15 | .. _plugins_in_@{collection_name}@: 16 | 17 | @{collection_name.title()}@ 18 | @{ '=' * (collection_name | column_width) }@ 19 | 20 | This collection has been removed from Ansible @{ collection_removal_version.major }@. 21 | 22 | If you want to continue using this collection, you can install it manually using 23 | @{ collection_name | collection_install | rst_code }@. 24 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/ansible-docsite/macros/collection_links.rst.j2: -------------------------------------------------------------------------------- 1 | {# 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | #} 6 | 7 | {% macro add(collection_links, collection_communication=None, collection=None) %} 8 | .. ansible-links:: 9 | 10 | {% for link in collection_links %} 11 | - title: @{ link.description | antsibull_to_json }@ 12 | url: @{ link.url | antsibull_to_json }@ 13 | external: true 14 | {% endfor %} 15 | {% if collection_communication and collection and not collection_communication.empty %} 16 | - title: Communication 17 | ref: communication_for_@{collection}@ 18 | {% endif %} 19 | 20 | {% endmacro %} 21 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/simplified-rst/collection-tombstone.rst.j2: -------------------------------------------------------------------------------- 1 | {# 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | #} 6 | 7 | {% if antsibull_docs_version %} 8 | .. Created with antsibull-docs @{ antsibull_docs_version }@ 9 | {% else %} 10 | .. Created with antsibull-docs 11 | {% endif %} 12 | 13 | @{collection_name.title()}@ 14 | @{ '=' * (collection_name | column_width) }@ 15 | 16 | This collection has been removed from Ansible @{ collection_removal_version.major }@. 17 | 18 | If you want to continue using this collection, you can install it manually using 19 | @{ collection_name | collection_install | rst_code }@. 20 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/simplified-rst/list_of_collections.rst.j2: -------------------------------------------------------------------------------- 1 | {# 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | #} 6 | 7 | {% if antsibull_docs_version %} 8 | .. Created with antsibull-docs @{ antsibull_docs_version }@ 9 | {% else %} 10 | .. Created with antsibull-docs 11 | {% endif %} 12 | 13 | Collection Index 14 | ================ 15 | 16 | {% if for_official_docsite %} 17 | These are the collections with docs hosted on `docs.ansible.com `_. 18 | {% else %} 19 | These are the collections documented here. 20 | {% endif %} 21 | 22 | {% for name in collections | sort %} 23 | * `@{ name }@ <@{ name | replace('.', '/') }@/index.rst>`_ 24 | {% endfor %} 25 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/simplified-rst/macros/collection_links.rst.j2: -------------------------------------------------------------------------------- 1 | {# 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | #} 6 | 7 | {% macro add(collection_links) %} 8 | {% for link in collection_links %} 9 | * `@{ link.description | rst_escape }@ <@{ link.url | rst_escape }@>`__ 10 | {% endfor %} 11 | {% endmacro %} 12 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/simplified-rst/plugin-deprecation.rst.j2: -------------------------------------------------------------------------------- 1 | {# 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | #} 6 | 7 | {% if antsibull_docs_version %} 8 | .. Created with antsibull-docs @{ antsibull_docs_version }@ 9 | {% else %} 10 | .. Created with antsibull-docs 11 | {% endif %} 12 | 13 | {% if short_description %} 14 | {% set title = alias ~ ' ' ~ plugin_type ~ ' -- ' ~ short_description | rst_ify %} 15 | {% else %} 16 | {% set title = alias ~ ' ' ~ plugin_type %} 17 | {% endif %} 18 | 19 | @{ title }@ 20 | @{ '+' * title|column_width }@ 21 | 22 | This is an alias for the @{ module }@ @{ plugin_type }@. 23 | This name has been **deprecated**. Please update your tasks to use the new name ``@{ module }@`` instead. 24 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/docsite/simplified-rst/plugin-error.rst.j2: -------------------------------------------------------------------------------- 1 | {# 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | #} 6 | 7 | {% if antsibull_docs_version %} 8 | .. Created with antsibull-docs @{ antsibull_docs_version }@ 9 | {% else %} 10 | .. Created with antsibull-docs 11 | {% endif %} 12 | 13 | {% set title = plugin_name ~ ' ' ~ plugin_type -%} 14 | 15 | @{ title }@ 16 | @{ '+' * title|column_width }@ 17 | 18 | The documentation for the @{ plugin_type }@ plugin, @{ plugin_name }@, was malformed. 19 | 20 | The errors were: 21 | 22 | {% for error in nonfatal_errors %} 23 | * :: 24 | 25 | @{ error | indent(width=8, first=True) }@ 26 | 27 | {% endfor %} 28 | 29 | File a bug with the `@{ collection }@ collection <@{ collection_issue_tracker or (collection | collection_url) }@>`_ in order to have it corrected. 30 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/sphinx_init/_gitignore.j2: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs @{ antsibull_docs_version }@ 6 | 7 | /build 8 | -------------------------------------------------------------------------------- /src/antsibull_docs/data/sphinx_init/requirements_txt.j2: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs @{ antsibull_docs_version }@ 6 | 7 | antsibull-docs >= 2.0.0, < 3.0.0 8 | ansible-pygments 9 | sphinx 10 | @{ sphinx_theme_package }@ 11 | -------------------------------------------------------------------------------- /src/antsibull_docs/markup/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | -------------------------------------------------------------------------------- /src/antsibull_docs/py.typed: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ansible-community/antsibull-docs/ae2f93e06488daaaa87accc91f468116f6002598/src/antsibull_docs/py.typed -------------------------------------------------------------------------------- /src/antsibull_docs/schemas/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | -------------------------------------------------------------------------------- /src/antsibull_docs/schemas/ansible_doc.py: -------------------------------------------------------------------------------- 1 | # Author: Toshio Kuratomi 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 3 | # https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | # SPDX-FileCopyrightText: 2021, Ansible Project 6 | """Compatibility package.""" 7 | 8 | from __future__ import annotations 9 | 10 | import warnings 11 | 12 | # This module is just a backwards compatible location for ansible_doc so the wildcard 13 | # import is just putting all the symbols from docs.ansible_doc into this namespace. 14 | # pylint: disable=wildcard-import,unused-wildcard-import 15 | from .docs.ansible_doc import * # noqa: F403,F401 16 | 17 | warnings.warn( 18 | "antsibull.schemas.ansible_doc is deprecated." 19 | " Use antsibull_docs.schemas.docs.ansible_doc instead.", 20 | DeprecationWarning, 21 | stacklevel=2, 22 | ) 23 | 24 | # TODO: remove in 3.0.0 25 | -------------------------------------------------------------------------------- /src/antsibull_docs/schemas/collection_config.py: -------------------------------------------------------------------------------- 1 | # Author: Felix Fontein 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 3 | # https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | # SPDX-FileCopyrightText: 2023, Ansible Project 6 | """Schemas for collection config files.""" 7 | 8 | import pydantic as p 9 | 10 | 11 | class ChangelogConfig(p.BaseModel): 12 | # Whether to write the changelog 13 | write_changelog: bool = False 14 | 15 | 16 | class CollectionConfig(p.BaseModel): 17 | # Whether the collection uses flatmapping to flatten subdirectories in 18 | # `plugins/*/`. 19 | flatmap: bool = False 20 | 21 | # List of environment variables that are defined by `.. envvar::` directives 22 | # in the extra docsite RST files. 23 | envvar_directives: list[str] = [] 24 | 25 | # Changelog configuration (added in version 2.10.0) 26 | changelog: ChangelogConfig = ChangelogConfig() 27 | -------------------------------------------------------------------------------- /src/antsibull_docs/utils/__init__.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2020, Ansible Project 5 | -------------------------------------------------------------------------------- /src/antsibull_docs/utils/get_pkg_data.py: -------------------------------------------------------------------------------- 1 | # Author: Felix Fontein 2 | # Author: Toshio Kuratomi 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 4 | # https://www.gnu.org/licenses/gpl-3.0.txt) 5 | # SPDX-License-Identifier: GPL-3.0-or-later 6 | # SPDX-FileCopyrightText: 2020, Ansible Project 7 | """Helper to use pkgutil.get_data without having to check the return value.""" 8 | 9 | from __future__ import annotations 10 | 11 | import pkgutil 12 | 13 | 14 | def get_antsibull_data(filename: str) -> bytes: 15 | """ 16 | Retrieve data from the antsibull_docs.data package as bytes. 17 | 18 | The filename can be a relative path separated with '/' to access subdirectories. 19 | See https://docs.python.org/3/library/pkgutil.html#pkgutil.get_data for details. 20 | """ 21 | data = pkgutil.get_data("antsibull_docs.data", filename) 22 | if data is None: 23 | raise RuntimeError(f"Cannot find {filename} in the antsibull_docs.data package") 24 | return data 25 | -------------------------------------------------------------------------------- /src/antsibull_docs/utils/rst.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 2 | # https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: 2022, Ansible Project 5 | """ 6 | ReStructured Text utils. 7 | """ 8 | 9 | 10 | def massage_rst_label(label: str) -> str: 11 | return " ".join(label.lower().split()) 12 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/antsibull-minimal.css.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible and contributors 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/antsibull.sty: -------------------------------------------------------------------------------- 1 | % GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | % SPDX-FileCopyrightText: Ansible and contributors 3 | % SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | \ProvidesPackage{antsibull}[Antsibull LaTeX markup] 6 | 7 | \RequirePackage{color} 8 | 9 | \definecolor{antsibull-blue}{HTML}{0000FF} 10 | \definecolor{antsibull-darkyellow}{HTML}{A5A500} 11 | \definecolor{antsibull-darkgreen}{HTML}{006400} 12 | \definecolor{antsibull-green}{HTML}{008000} 13 | \definecolor{antsibull-purple}{HTML}{800080} 14 | \definecolor{antsibull-red}{HTML}{FF0000} 15 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/colors-default-autodark.css.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible and contributors 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/colors-default-dark.css: -------------------------------------------------------------------------------- 1 | :root{--antsibull-links-background:#5bbdbf;--antsibull-links-background-active:#91d9db;--antsibull-links-focus-outline:#204748;--antsibull-links-text:#fff;--antsibull-table-background-header:#48484b;--antsibull-table-background-even:#1c1c1e;--antsibull-table-background-odd:#242426;--antsibull-table-border:#656569;--antsibull-narrowtable-background:#48484b;--antsibull-option-type:#ff93ff;--antsibull-option-elements:#ff93ff;--antsibull-option-required:#ff8282;--antsibull-option-version-added:#71d471;--antsibull-option-aliases:#71d471;--antsibull-option-default:#adadff;--antsibull-option-sample:#adadff;--antsibull-option-sample-header:#fff;--antsibull-attribute-support-none:#ff8282;--antsibull-attribute-support-partial:#b6b600;--antsibull-attribute-support-full:#0c0;--antsibull-attribute-support-na:inherit;--antsibull-deprecation-border:#fff;--antsibull-deprecation-background:#111;--antsibull-deprecation-color:#fff} -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/colors-default-dark.css.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible and contributors 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/colors-default.css: -------------------------------------------------------------------------------- 1 | :root{--antsibull-links-background:#5bbdbf;--antsibull-links-background-active:#91d9db;--antsibull-links-focus-outline:#204748;--antsibull-links-text:#fff;--antsibull-table-background-header:#6ab0de;--antsibull-table-background-even:#e7f2fa;--antsibull-table-background-odd:#fff;--antsibull-table-border:#000;--antsibull-narrowtable-background:#e7f2fa;--antsibull-option-type:purple;--antsibull-option-elements:purple;--antsibull-option-required:red;--antsibull-option-version-added:#006400;--antsibull-option-aliases:#006400;--antsibull-option-default:blue;--antsibull-option-sample:blue;--antsibull-option-sample-header:#000;--antsibull-attribute-support-none:red;--antsibull-attribute-support-partial:#a5a500;--antsibull-attribute-support-full:green;--antsibull-attribute-support-na:inherit;--antsibull-deprecation-border:#000;--antsibull-deprecation-background:#eee;--antsibull-deprecation-color:#000} -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/colors-default.css.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible and contributors 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/.gitignore: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible and contributors 2 | # GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | /node_modules 6 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/browserslistrc: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | last 4 versions 6 | > 0.1% 7 | 8 | Chrome >= 21 9 | and_chr >= 21 10 | 11 | Firefox >= 28 12 | and_ff >= 28 13 | 14 | Explorer >= 8 15 | ExplorerMobile >= 8 16 | not ie < 8 17 | Edge >= 12 18 | 19 | iOS >= 6 20 | Safari >= 6 21 | ios_saf >= 6 22 | 23 | Opera >= 12.1 24 | android >= 4 25 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/colors-default-autodark.scss: -------------------------------------------------------------------------------- 1 | // Copyright (c) Ansible and contributors 2 | // GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) 3 | // SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | @use 'default-colors-light' as light; 6 | @use 'default-colors-dark' as dark; 7 | 8 | :root { 9 | @include light.colors; 10 | 11 | @media (prefers-color-scheme: dark) { 12 | @include dark.colors; 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/colors-default-dark.scss: -------------------------------------------------------------------------------- 1 | // Copyright (c) Ansible and contributors 2 | // GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) 3 | // SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | @use 'default-colors-dark' as dark; 6 | 7 | :root { 8 | @include dark.colors; 9 | } 10 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/colors-default.scss: -------------------------------------------------------------------------------- 1 | // Copyright (c) Ansible and contributors 2 | // GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) 3 | // SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | @use 'default-colors-light' as light; 6 | 7 | :root { 8 | @include light.colors; 9 | } 10 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/cssnano.config.js: -------------------------------------------------------------------------------- 1 | // Copyright (c) Ansible Project 2 | // GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | // SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | module.exports = { 6 | preset: [ 7 | 'default', 8 | { 9 | discardComments: false 10 | } 11 | ] 12 | } 13 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/package-lock.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible and contributors 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "dependencies": { 3 | "autoprefixer": "^10.4.21", 4 | "cssnano": "^7.0.7", 5 | "postcss": "^8.5.3", 6 | "postcss-cli": "^11.0.1", 7 | "sass": "^1.89.0" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/css/package.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible and contributors 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/schemas/__init__.py: -------------------------------------------------------------------------------- 1 | # Author: Felix Fontein 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 3 | # https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | # SPDX-FileCopyrightText: 2023, Ansible Project 6 | -------------------------------------------------------------------------------- /src/sphinx_antsibull_ext/schemas/ansible_links.py: -------------------------------------------------------------------------------- 1 | # Author: Felix Fontein 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or 3 | # https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | # SPDX-FileCopyrightText: 2023, Ansible Project 6 | """Schema for ansible-links directive.""" 7 | 8 | from __future__ import annotations 9 | 10 | import typing as t 11 | 12 | import pydantic as p 13 | 14 | 15 | class AnsibleLink(p.BaseModel): 16 | title: str 17 | url: t.Optional[str] = None 18 | ref: t.Optional[str] = None 19 | external: bool = False 20 | 21 | @p.model_validator(mode="before") 22 | @classmethod 23 | def one_of_url_and_ref(cls, values: t.Any) -> t.Any: 24 | if isinstance(values, dict): 25 | has_url = values.get("url") 26 | has_ref = values.get("ref") 27 | if has_url == has_ref: 28 | raise ValueError("Exactly one of 'url' and 'ref' must be specified.") 29 | return values 30 | 31 | 32 | class AnsibleLinks(p.BaseModel): 33 | data: list[AnsibleLink] 34 | -------------------------------------------------------------------------------- /stubs/ansible/__init__.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/cli/__init__.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/cli/arguments.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/collections/list.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/constants.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | 6 | DOCUMENTABLE_PLUGINS: tuple[str, ...] 7 | -------------------------------------------------------------------------------- /stubs/ansible/galaxy/collection.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/module_utils/_text.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/module_utils/common/json.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/plugins/loader.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/release.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | __version__: str 6 | __codename__: str 7 | -------------------------------------------------------------------------------- /stubs/ansible/utils/collection_loader.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/ansible/utils/plugin_docs.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/argcomplete.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | import argparse 6 | 7 | def autocomplete(parser: argparse.ArgumentParser): ... 8 | -------------------------------------------------------------------------------- /stubs/jinja2/utils.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | import typing as t 6 | 7 | F = t.TypeVar("F", bound=t.Callable[..., t.Any]) 8 | 9 | def pass_context(f: F) -> F: ... 10 | def pass_eval_context(f: F) -> F: ... 11 | def pass_environment(f: F) -> F: ... 12 | -------------------------------------------------------------------------------- /stubs/rstcheck.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | 6 | import docutils.utils 7 | 8 | def check(source: str, 9 | filename: str | None = ..., 10 | report_level: docutils.utils.Reporter | int = ..., 11 | ignore: dict | None = ..., 12 | debug: bool = ...) -> list[tuple[int, str]]: ... 13 | 14 | def ignore_directives_and_roles(directives: list[str], roles: list[str]) -> None: ... 15 | -------------------------------------------------------------------------------- /stubs/rstcheck_core/__init__.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /stubs/rstcheck_core/checker.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | import pathlib 6 | 7 | from . import config, types 8 | 9 | def check_file( 10 | source_file: pathlib.Path, 11 | rstcheck_config: config.RstcheckConfig, 12 | overwrite_with_file_config: bool = True, 13 | ) -> list[types.LintError]: ... 14 | -------------------------------------------------------------------------------- /stubs/rstcheck_core/config.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | import enum 6 | 7 | class ReportLevel(enum.Enum): 8 | INFO = 1 9 | WARNING = 2 10 | ERROR = 3 11 | SEVERE = 4 12 | NONE = 5 13 | 14 | 15 | class RstcheckConfig: 16 | def __init__( 17 | self, 18 | report_level: ReportLevel | None = ..., 19 | ignore_directives: list[str] | None = ..., 20 | ignore_roles: list[str] | None = ..., 21 | ignore_substitutions: list[str] | None = ..., 22 | ignore_languages: list[str] | None = ..., 23 | ): ... 24 | -------------------------------------------------------------------------------- /stubs/rstcheck_core/types.pyi: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | import pathlib 6 | from typing import Literal 7 | 8 | try: 9 | from typing import TypedDict 10 | except ImportError: 11 | from typing_extensions import TypedDict 12 | 13 | 14 | class LintError(TypedDict): 15 | source_origin: pathlib.Path | Literal[""] | Literal[""] 16 | line_number: int 17 | message: str 18 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-all-others.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-all.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-ansible.builtin-ns.col2-ns2.col.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-ansible.builtin-ns2.col.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-ansible.builtin-ns2.flatcol.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-ns.col1-ns.col2-ns2.col-ns2.flatcol.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-ns.col1-ns2.col-ns2.flatcol.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-ns.col2.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-doc-cache-ns2.col.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-all-others.json: -------------------------------------------------------------------------------- 1 | { 2 | "../other-collections/ansible_collections": { 3 | "ext.col": { 4 | "version": "3.0.0" 5 | } 6 | }, 7 | "ansible_collections": { 8 | "ns.col1": { 9 | "version": "*" 10 | }, 11 | "ns.col2": { 12 | "version": "0.0.1" 13 | }, 14 | "ns2.col": { 15 | "version": "2.1.0" 16 | }, 17 | "ns2.flatcol": { 18 | "version": "*" 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-all-others.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-all.json: -------------------------------------------------------------------------------- 1 | { 2 | "ansible_collections": { 3 | "ns.col1": { 4 | "version": "*" 5 | }, 6 | "ns.col2": { 7 | "version": "0.0.1" 8 | }, 9 | "ns2.col": { 10 | "version": "2.1.0" 11 | }, 12 | "ns2.flatcol": { 13 | "version": "*" 14 | } 15 | } 16 | } -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-all.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-ns.col2.json: -------------------------------------------------------------------------------- 1 | { 2 | "ansible_collections": { 3 | "ns.col2": { 4 | "version": "0.0.1" 5 | } 6 | } 7 | } -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-ns.col2.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-ns2.col.json: -------------------------------------------------------------------------------- 1 | { 2 | "ansible_collections": { 3 | "ns2.col": { 4 | "version": "2.1.0" 5 | } 6 | } 7 | } -------------------------------------------------------------------------------- /tests/functional/ansible-galaxy-cache-ns2.col.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/ansible-version.output: -------------------------------------------------------------------------------- 1 | ansible [core 2.19.0.dev0] (devel 35a712588e) last updated 2025/01/15 21:46:38 (GMT +200) 2 | config file = None 3 | configured module search path = ['<<<<>>>>/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] 4 | ansible python module location = <<<<>>>> 5 | ansible collection location = <<<<>>>> 6 | executable location = <<<<>>>>/.local/bin/ansible 7 | python version = 3.13.1 (main, Dec 4 2024, 18:05:56) [GCC 14.2.1 20240910] (/usr/bin/python) 8 | jinja version = 3.1.5 9 | libyaml = True 10 | -------------------------------------------------------------------------------- /tests/functional/ansible-version.output.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/antsibull-docs-stub.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | from __future__ import annotations 7 | 8 | import sys 9 | 10 | from utils import ANTSIBULL_DOCS_CI_VERSION 11 | 12 | import antsibull_docs 13 | from antsibull_docs.cli.antsibull_docs import main 14 | 15 | if __name__ == "__main__": 16 | antsibull_docs.__version__ = ANTSIBULL_DOCS_CI_VERSION 17 | sys.exit(main()) 18 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/callback_index_stdout.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_stdout_callback_plugins: 7 | 8 | Index of all Stdout Callback Plugins 9 | ==================================== 10 | 11 | See :ref:`list_of_callback_plugins` for the list of *all* callback plugins. 12 | 13 | ns2.col 14 | ------- 15 | 16 | * :ansplugin:`ns2.col.foo#callback` -- Foo output :ansopt:`ns2.col.foo#callback:bar` 17 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_collections: 7 | 8 | Collection Index 9 | ================ 10 | 11 | These are the collections documented here. 12 | 13 | * :ref:`ns.col1 ` 14 | * :ref:`ns.col2 ` 15 | * :ref:`ns2.col ` 16 | * :ref:`ns2.flatcol ` 17 | 18 | .. toctree:: 19 | :maxdepth: 1 20 | :hidden: 21 | 22 | ns/index 23 | ns2/index 24 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_become.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_become_plugins: 7 | 8 | Index of all Become Plugins 9 | =========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#become` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#become` -- Use foo :ansopt:`ns2.col.foo#become:bar` :ansdeprecatedmarker:`{"date": "", "version": "5.0.0"}` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_cache.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_cache_plugins: 7 | 8 | Index of all Cache Plugins 9 | ========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#cache` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#cache` -- Foo files :ansopt:`ns2.col.foo#cache:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_callback.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_callback_plugins: 7 | 8 | Index of all Callback Plugins 9 | ============================= 10 | 11 | .. toctree:: 12 | :maxdepth: 1 13 | :caption: List of callback plugins by callback type 14 | :glob: 15 | 16 | callback_index_* 17 | 18 | 19 | ns.col2 20 | ------- 21 | 22 | * :ansplugin:`ns.col2.extra#callback` -- 23 | 24 | ns2.col 25 | ------- 26 | 27 | * :ansplugin:`ns2.col.foo#callback` -- Foo output :ansopt:`ns2.col.foo#callback:bar` 28 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_cliconf.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_cliconf_plugins: 7 | 8 | Index of all Cliconf Plugins 9 | ============================ 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#cliconf` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#cliconf` -- Foo router CLI config 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_connection.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_connection_plugins: 7 | 8 | Index of all Connection Plugins 9 | =============================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#connection` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#connection` -- Foo connection :ansopt:`ns2.col.foo#connection:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_filter.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_filter_plugins: 7 | 8 | Index of all Filter Plugins 9 | =========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#filter` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.bar#filter` -- The bar filter 20 | * :ansplugin:`ns2.col.foo#filter` -- The foo filter :ansopt:`ns2.col.foo#filter:bar` 21 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_inventory.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_inventory_plugins: 7 | 8 | Index of all Inventory Plugins 9 | ============================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#inventory` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#inventory` -- The foo inventory :ansopt:`ns2.col.foo#inventory:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_lookup.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_lookup_plugins: 7 | 8 | Index of all Lookup Plugins 9 | =========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#lookup` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#lookup` -- Look up some foo :ansopt:`ns2.col.foo#lookup:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_module.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_module_plugins: 7 | 8 | Index of all Modules 9 | ==================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#module` -- 15 | * :ansplugin:`ns.col2.foo#module` -- 16 | * :ansplugin:`ns.col2.foo2#module` -- Foo two 17 | * :ansplugin:`ns.col2.foo3#module` -- Foo III 18 | * :ansplugin:`ns.col2.foo4#module` -- Markup reference linting test 19 | 20 | ns2.col 21 | ------- 22 | 23 | * :ansplugin:`ns2.col.foo#module` -- Do some foo :ansopt:`ns2.col.foo#module:bar` 24 | * :ansplugin:`ns2.col.foo2#module` -- Another foo 25 | * :ansplugin:`ns2.col.sub.foo3#module` -- A sub-foo 26 | 27 | ns2.flatcol 28 | ----------- 29 | 30 | * :ansplugin:`ns2.flatcol.foo#module` -- Do some foo :ansopt:`ns2.flatcol.foo#module:bar` 31 | * :ansplugin:`ns2.flatcol.foo2#module` -- Another foo 32 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_role.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_role_plugins: 7 | 8 | Index of all Roles 9 | ================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.bar#role` -- Bar role 15 | * :ansplugin:`ns.col2.extra#role` -- 16 | 17 | ns2.col 18 | ------- 19 | 20 | * :ansplugin:`ns2.col.foo#role` -- Foo role :ansdeprecatedmarker:`{"date": "2020-01-01", "version": ""}` 21 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_shell.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_shell_plugins: 7 | 8 | Index of all Shell Plugins 9 | ========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#shell` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#shell` -- Foo shell :ansopt:`ns2.col.foo#shell:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_strategy.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_strategy_plugins: 7 | 8 | Index of all Strategy Plugins 9 | ============================= 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#strategy` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#strategy` -- Executes tasks in foo 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_test.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_test_plugins: 7 | 8 | Index of all Test Plugins 9 | ========================= 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#test` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.bar#test` -- Is something a bar 20 | * :ansplugin:`ns2.col.foo#test` -- Is something a foo :ansopt:`ns2.col.foo#test:bar` 21 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/index_vars.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_vars_plugins: 7 | 8 | Index of all Vars Plugins 9 | ========================= 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#vars` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#vars` -- Load foo :ansopt:`ns2.col.foo#vars:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col1/index.rst: -------------------------------------------------------------------------------- 1 | .. meta:: 2 | :antsibull-docs: 3 | 4 | 5 | .. _plugins_in_ns.col1: 6 | 7 | Ns.Col1 8 | ======= 9 | 10 | 11 | .. contents:: 12 | :local: 13 | :depth: 1 14 | 15 | Description 16 | ----------- 17 | 18 | A short description. 19 | 20 | **Authors:** 21 | 22 | * Ansible (https://github.com/ansible) 23 | * Foo Bar (@ansible) 24 | * Test 25 | 26 | 27 | 28 | 29 | 30 | .. toctree:: 31 | :maxdepth: 1 32 | 33 | Changelog 34 | --------- 35 | 36 | .. toctree:: 37 | :maxdepth: 1 38 | 39 | changelog 40 | 41 | Plugin Index 42 | ------------ 43 | 44 | There are no plugins in the ns.col1 collection with automatically generated documentation. 45 | 46 | 47 | 48 | .. seealso:: 49 | 50 | List of :ref:`collections ` with docs hosted here. 51 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_callback.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_callback: 13 | 14 | .. Title 15 | 16 | ns.col2.extra callback 17 | ++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the callback plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for CallbackDocSchema 27 | doc -> options -> bar -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_cliconf.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_cliconf: 13 | 14 | .. Title 15 | 16 | ns.col2.extra cliconf 17 | +++++++++++++++++++++ 18 | 19 | 20 | The documentation for the cliconf plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 1 validation error for PluginDocSchema 27 | doc -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | 30 | 31 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 32 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_connection.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_connection: 13 | 14 | .. Title 15 | 16 | ns.col2.extra connection 17 | ++++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the connection plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 3 validation errors for PluginDocSchema 27 | doc -> options -> host -> vars -> 0 -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> options -> host -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | doc -> extra 32 | Extra inputs are not permitted (type=extra_forbidden) 33 | 34 | 35 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 36 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_filter.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_filter: 13 | 14 | .. Title 15 | 16 | ns.col2.extra filter 17 | ++++++++++++++++++++ 18 | 19 | 20 | The documentation for the filter plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PositionalDocSchema 27 | doc -> options -> _input -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_inventory.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_inventory: 13 | 14 | .. Title 15 | 16 | ns.col2.extra inventory 17 | +++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the inventory plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PluginDocSchema 27 | doc -> options -> bar -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_lookup.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_lookup: 13 | 14 | .. Title 15 | 16 | ns.col2.extra lookup 17 | ++++++++++++++++++++ 18 | 19 | 20 | The documentation for the lookup plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PositionalDocSchema 27 | doc -> options -> _terms -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_strategy.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_strategy: 13 | 14 | .. Title 15 | 16 | ns.col2.extra strategy 17 | ++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the strategy plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 1 validation error for PluginDocSchema 27 | doc -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | 30 | 31 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 32 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/col2/extra_test.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_test: 13 | 14 | .. Title 15 | 16 | ns.col2.extra test 17 | ++++++++++++++++++ 18 | 19 | 20 | The documentation for the test plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PositionalDocSchema 27 | doc -> options -> _input -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns/index.rst: -------------------------------------------------------------------------------- 1 | .. meta:: 2 | :antsibull-docs: 3 | 4 | .. _list_of_collections_ns: 5 | 6 | Collections in the Ns Namespace 7 | =============================== 8 | 9 | These are the collections documented here in the **ns** namespace. 10 | 11 | * :ref:`ns.col1 ` 12 | * :ref:`ns.col2 ` 13 | 14 | .. toctree:: 15 | :maxdepth: 1 16 | :hidden: 17 | 18 | col1/index 19 | col2/index 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/changelog.rst: -------------------------------------------------------------------------------- 1 | The changelog of ns2.col is empty. -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/docsite/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/foo_1_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_1_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_1_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/foo_2_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_2_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_2_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/foo_3_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_3_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_3_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/foo_4_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_4_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_4_redirect 15 | ++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This plugin was part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | This module has been removed 23 | in version 2.0.0 of ns2.col. 24 | It is gone 25 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/foo_5_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_5_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_5_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | 23 | - This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. 24 | It will be removed in version 5.0.0 of ns2.col. 25 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 26 | - This redirect does **not** work with Ansible 2.9. 27 | - The collection contains the following information on this deprecation: It will be really gone 28 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/foo_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_redirect module 15 | +++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/col/is_bar_test.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.is_bar_test: 11 | 12 | .. Title 13 | 14 | ns2.col.is_bar test 15 | +++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.is_bar`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.bar test plugin `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-default/collections/ns2/index.rst: -------------------------------------------------------------------------------- 1 | .. meta:: 2 | :antsibull-docs: 3 | 4 | .. _list_of_collections_ns2: 5 | 6 | Collections in the Ns2 Namespace 7 | ================================ 8 | 9 | These are the collections documented here in the **ns2** namespace. 10 | 11 | * :ref:`ns2.col ` 12 | * :ref:`ns2.flatcol ` 13 | 14 | .. toctree:: 15 | :maxdepth: 1 16 | :hidden: 17 | 18 | col/index 19 | flatcol/index 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/callback_index_stdout.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_stdout_callback_plugins: 7 | 8 | Index of all Stdout Callback Plugins 9 | ==================================== 10 | 11 | See :ref:`list_of_callback_plugins` for the list of *all* callback plugins. 12 | 13 | ns2.col 14 | ------- 15 | 16 | * :ansplugin:`ns2.col.foo#callback` -- Foo output :ansopt:`ns2.col.foo#callback:bar` 17 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_collections: 7 | 8 | Collection Index 9 | ================ 10 | 11 | These are the collections documented here. 12 | 13 | * :ref:`ns.col1 ` 14 | * :ref:`ns.col2 ` 15 | * :ref:`ns2.col ` 16 | * :ref:`ns2.flatcol ` 17 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_become.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_become_plugins: 7 | 8 | Index of all Become Plugins 9 | =========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#become` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#become` -- Use foo :ansopt:`ns2.col.foo#become:bar` :ansdeprecatedmarker:`{"date": "", "version": "5.0.0"}` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_cache.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_cache_plugins: 7 | 8 | Index of all Cache Plugins 9 | ========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#cache` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#cache` -- Foo files :ansopt:`ns2.col.foo#cache:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_callback.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_callback_plugins: 7 | 8 | Index of all Callback Plugins 9 | ============================= 10 | 11 | .. toctree:: 12 | :maxdepth: 1 13 | :caption: List of callback plugins by callback type 14 | :glob: 15 | 16 | callback_index_* 17 | 18 | 19 | ns.col2 20 | ------- 21 | 22 | * :ansplugin:`ns.col2.extra#callback` -- 23 | 24 | ns2.col 25 | ------- 26 | 27 | * :ansplugin:`ns2.col.foo#callback` -- Foo output :ansopt:`ns2.col.foo#callback:bar` 28 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_cliconf.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_cliconf_plugins: 7 | 8 | Index of all Cliconf Plugins 9 | ============================ 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#cliconf` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#cliconf` -- Foo router CLI config 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_connection.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_connection_plugins: 7 | 8 | Index of all Connection Plugins 9 | =============================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#connection` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#connection` -- Foo connection :ansopt:`ns2.col.foo#connection:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_filter.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_filter_plugins: 7 | 8 | Index of all Filter Plugins 9 | =========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#filter` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.bar#filter` -- The bar filter 20 | * :ansplugin:`ns2.col.foo#filter` -- The foo filter :ansopt:`ns2.col.foo#filter:bar` 21 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_inventory.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_inventory_plugins: 7 | 8 | Index of all Inventory Plugins 9 | ============================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#inventory` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#inventory` -- The foo inventory :ansopt:`ns2.col.foo#inventory:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_lookup.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_lookup_plugins: 7 | 8 | Index of all Lookup Plugins 9 | =========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#lookup` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#lookup` -- Look up some foo :ansopt:`ns2.col.foo#lookup:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_module.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_module_plugins: 7 | 8 | Index of all Modules 9 | ==================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#module` -- 15 | * :ansplugin:`ns.col2.foo#module` -- 16 | * :ansplugin:`ns.col2.foo2#module` -- Foo two 17 | * :ansplugin:`ns.col2.foo3#module` -- Foo III 18 | * :ansplugin:`ns.col2.foo4#module` -- Markup reference linting test 19 | 20 | ns2.col 21 | ------- 22 | 23 | * :ansplugin:`ns2.col.foo#module` -- Do some foo :ansopt:`ns2.col.foo#module:bar` 24 | * :ansplugin:`ns2.col.foo2#module` -- Another foo 25 | * :ansplugin:`ns2.col.sub.foo3#module` -- A sub-foo 26 | 27 | ns2.flatcol 28 | ----------- 29 | 30 | * :ansplugin:`ns2.flatcol.foo#module` -- Do some foo :ansopt:`ns2.flatcol.foo#module:bar` 31 | * :ansplugin:`ns2.flatcol.foo2#module` -- Another foo 32 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_role.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_role_plugins: 7 | 8 | Index of all Roles 9 | ================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.bar#role` -- Bar role 15 | * :ansplugin:`ns.col2.extra#role` -- 16 | 17 | ns2.col 18 | ------- 19 | 20 | * :ansplugin:`ns2.col.foo#role` -- Foo role :ansdeprecatedmarker:`{"date": "2020-01-01", "version": ""}` 21 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_shell.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_shell_plugins: 7 | 8 | Index of all Shell Plugins 9 | ========================== 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#shell` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#shell` -- Foo shell :ansopt:`ns2.col.foo#shell:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_strategy.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_strategy_plugins: 7 | 8 | Index of all Strategy Plugins 9 | ============================= 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#strategy` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#strategy` -- Executes tasks in foo 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_test.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_test_plugins: 7 | 8 | Index of all Test Plugins 9 | ========================= 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#test` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.bar#test` -- Is something a bar 20 | * :ansplugin:`ns2.col.foo#test` -- Is something a foo :ansopt:`ns2.col.foo#test:bar` 21 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/index_vars.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_vars_plugins: 7 | 8 | Index of all Vars Plugins 9 | ========================= 10 | 11 | ns.col2 12 | ------- 13 | 14 | * :ansplugin:`ns.col2.extra#vars` -- 15 | 16 | ns2.col 17 | ------- 18 | 19 | * :ansplugin:`ns2.col.foo#vars` -- Load foo :ansopt:`ns2.col.foo#vars:bar` 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col1/index.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | 7 | .. _plugins_in_ns.col1: 8 | 9 | Ns.Col1 10 | ======= 11 | 12 | 13 | .. contents:: 14 | :local: 15 | :depth: 1 16 | 17 | Description 18 | ----------- 19 | 20 | A short description. 21 | 22 | **Authors:** 23 | 24 | * Ansible (https://github.com/ansible) 25 | * Foo Bar (@ansible) 26 | * Test 27 | 28 | 29 | 30 | 31 | 32 | .. toctree:: 33 | :maxdepth: 1 34 | 35 | Changelog 36 | --------- 37 | 38 | .. toctree:: 39 | :maxdepth: 1 40 | 41 | changelog 42 | 43 | Plugin Index 44 | ------------ 45 | 46 | There are no plugins in the ns.col1 collection with automatically generated documentation. 47 | 48 | 49 | 50 | .. seealso:: 51 | 52 | List of :ref:`collections ` with docs hosted here. 53 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_callback.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_callback: 13 | 14 | .. Title 15 | 16 | ns.col2.extra callback 17 | ++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the callback plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for CallbackDocSchema 27 | doc -> options -> bar -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_cliconf.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_cliconf: 13 | 14 | .. Title 15 | 16 | ns.col2.extra cliconf 17 | +++++++++++++++++++++ 18 | 19 | 20 | The documentation for the cliconf plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 1 validation error for PluginDocSchema 27 | doc -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | 30 | 31 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 32 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_connection.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_connection: 13 | 14 | .. Title 15 | 16 | ns.col2.extra connection 17 | ++++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the connection plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 3 validation errors for PluginDocSchema 27 | doc -> options -> host -> vars -> 0 -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> options -> host -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | doc -> extra 32 | Extra inputs are not permitted (type=extra_forbidden) 33 | 34 | 35 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 36 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_filter.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_filter: 13 | 14 | .. Title 15 | 16 | ns.col2.extra filter 17 | ++++++++++++++++++++ 18 | 19 | 20 | The documentation for the filter plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PositionalDocSchema 27 | doc -> options -> _input -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_inventory.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_inventory: 13 | 14 | .. Title 15 | 16 | ns.col2.extra inventory 17 | +++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the inventory plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PluginDocSchema 27 | doc -> options -> bar -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_lookup.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_lookup: 13 | 14 | .. Title 15 | 16 | ns.col2.extra lookup 17 | ++++++++++++++++++++ 18 | 19 | 20 | The documentation for the lookup plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PositionalDocSchema 27 | doc -> options -> _terms -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_strategy.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_strategy: 13 | 14 | .. Title 15 | 16 | ns.col2.extra strategy 17 | ++++++++++++++++++++++ 18 | 19 | 20 | The documentation for the strategy plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 1 validation error for PluginDocSchema 27 | doc -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | 30 | 31 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 32 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/col2/extra_test.rst: -------------------------------------------------------------------------------- 1 | .. Document meta section 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Document body 9 | 10 | .. Anchors 11 | 12 | .. _ansible_collections.ns.col2.extra_test: 13 | 14 | .. Title 15 | 16 | ns.col2.extra test 17 | ++++++++++++++++++ 18 | 19 | 20 | The documentation for the test plugin, ns.col2.extra, was malformed. 21 | 22 | The errors were: 23 | 24 | * .. code-block:: text 25 | 26 | 2 validation errors for PositionalDocSchema 27 | doc -> options -> _input -> extra 28 | Extra inputs are not permitted (type=extra_forbidden) 29 | doc -> extra 30 | Extra inputs are not permitted (type=extra_forbidden) 31 | 32 | 33 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 34 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns/index.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_collections_ns: 7 | 8 | Collections in the Ns Namespace 9 | =============================== 10 | 11 | These are the collections documented here in the **ns** namespace. 12 | 13 | * :ref:`ns.col1 ` 14 | * :ref:`ns.col2 ` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/changelog.rst: -------------------------------------------------------------------------------- 1 | The changelog of ns2.col is empty. -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/docsite/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_1_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_1_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_1_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_2_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_2_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_2_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_3_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_3_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_3_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_4_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_4_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_4_redirect 15 | ++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This plugin was part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | This module has been removed 23 | in version 2.0.0 of ns2.col. 24 | It is gone 25 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_5_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_5_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_5_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | 23 | - This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. 24 | It will be removed in version 5.0.0 of ns2.col. 25 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 26 | - This redirect does **not** work with Ansible 2.9. 27 | - The collection contains the following information on this deprecation: It will be really gone 28 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_redirect module 15 | +++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/col/is_bar_test.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.is_bar_test: 11 | 12 | .. Title 13 | 14 | ns2.col.is_bar test 15 | +++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.is_bar`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.bar test plugin `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-breadcrumbs/collections/ns2/index.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_collections_ns2: 7 | 8 | Collections in the Ns2 Namespace 9 | ================================ 10 | 11 | These are the collections documented here in the **ns2** namespace. 12 | 13 | * :ref:`ns2.col ` 14 | * :ref:`ns2.flatcol ` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns/col1/index.rst: -------------------------------------------------------------------------------- 1 | .. _plugins_in_ns.col1: 2 | 3 | Ns.Col1 4 | ======= 5 | 6 | 7 | .. contents:: 8 | :local: 9 | :depth: 1 10 | 11 | Description 12 | ----------- 13 | 14 | A short description. 15 | 16 | **Authors:** 17 | 18 | * Ansible (https://github.com/ansible) 19 | * Foo Bar (@ansible) 20 | * Test 21 | 22 | 23 | 24 | 25 | 26 | .. toctree:: 27 | :maxdepth: 1 28 | 29 | Changelog 30 | --------- 31 | 32 | .. toctree:: 33 | :maxdepth: 1 34 | 35 | changelog 36 | 37 | Plugin Index 38 | ------------ 39 | 40 | There are no plugins in the ns.col1 collection with automatically generated documentation. 41 | 42 | 43 | 44 | .. seealso:: 45 | 46 | List of :ref:`collections ` with docs hosted here. 47 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/changelog.rst: -------------------------------------------------------------------------------- 1 | The changelog of ns2.col is empty. -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/docsite/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/foo_1_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. Anchors 6 | 7 | .. _ansible_collections.ns2.col.foo_1_redirect_module: 8 | 9 | .. Title 10 | 11 | ns2.col.foo_1_redirect module 12 | +++++++++++++++++++++++++++++ 13 | 14 | .. Collection note 15 | 16 | .. note:: 17 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 18 | 19 | To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. 20 | 21 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 22 | - This redirect does **not** work with Ansible 2.9. 23 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/foo_2_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. Anchors 6 | 7 | .. _ansible_collections.ns2.col.foo_2_redirect_module: 8 | 9 | .. Title 10 | 11 | ns2.col.foo_2_redirect module 12 | +++++++++++++++++++++++++++++ 13 | 14 | .. Collection note 15 | 16 | .. note:: 17 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 18 | 19 | To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. 20 | 21 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 22 | - This redirect does **not** work with Ansible 2.9. 23 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/foo_3_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. Anchors 6 | 7 | .. _ansible_collections.ns2.col.foo_3_redirect_module: 8 | 9 | .. Title 10 | 11 | ns2.col.foo_3_redirect module 12 | +++++++++++++++++++++++++++++ 13 | 14 | .. Collection note 15 | 16 | .. note:: 17 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 18 | 19 | To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. 20 | 21 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 22 | - This redirect does **not** work with Ansible 2.9. 23 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/foo_4_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. Anchors 6 | 7 | .. _ansible_collections.ns2.col.foo_4_redirect_module: 8 | 9 | .. Title 10 | 11 | ns2.col.foo_4_redirect 12 | ++++++++++++++++++++++ 13 | 14 | .. Collection note 15 | 16 | .. note:: 17 | This plugin was part of the `ns2.col collection `_ (version 2.1.0). 18 | 19 | This module has been removed 20 | in version 2.0.0 of ns2.col. 21 | It is gone 22 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/foo_5_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. Anchors 6 | 7 | .. _ansible_collections.ns2.col.foo_5_redirect_module: 8 | 9 | .. Title 10 | 11 | ns2.col.foo_5_redirect module 12 | +++++++++++++++++++++++++++++ 13 | 14 | .. Collection note 15 | 16 | .. note:: 17 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 18 | 19 | 20 | - This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. 21 | It will be removed in version 5.0.0 of ns2.col. 22 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 23 | - This redirect does **not** work with Ansible 2.9. 24 | - The collection contains the following information on this deprecation: It will be really gone 25 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/foo_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. Anchors 6 | 7 | .. _ansible_collections.ns2.col.foo_redirect_module: 8 | 9 | .. Title 10 | 11 | ns2.col.foo_redirect module 12 | +++++++++++++++++++++++++++ 13 | 14 | .. Collection note 15 | 16 | .. note:: 17 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 18 | 19 | To use it in a playbook, specify: :code:`ns2.col.foo_redirect`. 20 | 21 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 22 | - This redirect does **not** work with Ansible 2.9. 23 | -------------------------------------------------------------------------------- /tests/functional/baseline-no-indexes/collections/ns2/col/is_bar_test.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. Anchors 6 | 7 | .. _ansible_collections.ns2.col.is_bar_test: 8 | 9 | .. Title 10 | 11 | ns2.col.is_bar test 12 | +++++++++++++++++++ 13 | 14 | .. Collection note 15 | 16 | .. note:: 17 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 18 | 19 | To use it in a playbook, specify: :code:`ns2.col.is_bar`. 20 | 21 | - This is a redirect to the :ansplugin:`ns2.col.bar test plugin `. 22 | - This redirect does **not** work with Ansible 2.9. 23 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/changelog.rst: -------------------------------------------------------------------------------- 1 | The changelog of ns2.col is empty. -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/docsite/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/foo_1_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_1_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_1_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/foo_2_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_2_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_2_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/foo_3_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_3_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_3_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo2 module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/foo_4_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_4_redirect 4 | ++++++++++++++++++++++ 5 | 6 | This plugin was part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | This module has been removed 9 | in version 2.0.0 of ns2.col. 10 | It is gone 11 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/foo_5_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_5_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | 9 | - This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. 10 | It will be removed in version 5.0.0 of ns2.col. 11 | - This is a redirect to the ns2.col.foo2 module. 12 | - This redirect does **not** work with Ansible 2.9. 13 | - The collection contains the following information on this deprecation: It will be really gone 14 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/foo_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_redirect module 4 | +++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst-squash-hierarchy/is_bar_test.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.is_bar test 4 | +++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.is_bar``. 9 | 10 | - This is a redirect to the ns2.col.bar test plugin. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/callback_index_stdout.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Stdout Callback Plugins 4 | ==================================== 5 | 6 | See `List of all Callback Plugins `_ for the list of *all* callback plugins. 7 | 8 | ns2.col 9 | ------- 10 | 11 | * `ns2.col.foo `_ -- Foo output :literal:`bar` (of callback plugin `ns2.col.foo `__) 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Collection Index 4 | ================ 5 | 6 | These are the collections documented here. 7 | 8 | * `ns.col1 `_ 9 | * `ns.col2 `_ 10 | * `ns2.col `_ 11 | * `ns2.flatcol `_ 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_become.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Become Plugins 4 | =========================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Use foo :literal:`bar` (of become plugin `ns2.col.foo `__) **(DEPRECATED)** 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_cache.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Cache Plugins 4 | ========================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Foo files :literal:`bar` (of cache plugin `ns2.col.foo `__) 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_callback.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Callback Plugins 4 | ============================= 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Foo output :literal:`bar` (of callback plugin `ns2.col.foo `__) 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_cliconf.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Cliconf Plugins 4 | ============================ 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Foo router CLI config 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_connection.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Connection Plugins 4 | =============================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Foo connection :literal:`bar` (of connection plugin `ns2.col.foo `__) 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_filter.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Filter Plugins 4 | =========================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.bar `_ -- The bar filter 15 | * `ns2.col.foo `_ -- The foo filter :literal:`bar` (of filter plugin `ns2.col.foo `__) 16 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_inventory.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Inventory Plugins 4 | ============================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- The foo inventory :literal:`bar` (of inventory plugin `ns2.col.foo `__) 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_lookup.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Lookup Plugins 4 | =========================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Look up some foo :literal:`bar` (of lookup plugin `ns2.col.foo `__) 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Modules 4 | ==================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | * `ns.col2.foo `_ -- 11 | * `ns.col2.foo2 `_ -- Foo two 12 | * `ns.col2.foo3 `_ -- Foo III 13 | * `ns.col2.foo4 `_ -- Markup reference linting test 14 | 15 | ns2.col 16 | ------- 17 | 18 | * `ns2.col.foo `_ -- Do some foo :literal:`bar` (of module `ns2.col.foo `__) 19 | * `ns2.col.foo2 `_ -- Another foo 20 | * `ns2.col.sub.foo3 `_ -- A sub-foo 21 | 22 | ns2.flatcol 23 | ----------- 24 | 25 | * `ns2.flatcol.foo `_ -- Do some foo :literal:`bar` (of module `ns2.flatcol.foo `__) 26 | * `ns2.flatcol.foo2 `_ -- Another foo 27 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_role.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Roles 4 | ================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.bar `_ -- Bar role 10 | * `ns.col2.extra `_ -- 11 | 12 | ns2.col 13 | ------- 14 | 15 | * `ns2.col.foo `_ -- Foo role **(DEPRECATED)** 16 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_shell.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Shell Plugins 4 | ========================== 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Foo shell :literal:`bar` (of shell plugin `ns2.col.foo `__) 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_strategy.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Strategy Plugins 4 | ============================= 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Executes tasks in foo 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_test.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Test Plugins 4 | ========================= 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.bar `_ -- Is something a bar 15 | * `ns2.col.foo `_ -- Is something a foo :literal:`bar` (of test plugin `ns2.col.foo `__) 16 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/index_vars.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | Index of all Vars Plugins 4 | ========================= 5 | 6 | ns.col2 7 | ------- 8 | 9 | * `ns.col2.extra `_ -- 10 | 11 | ns2.col 12 | ------- 13 | 14 | * `ns2.col.foo `_ -- Load foo :literal:`bar` (of vars plugin `ns2.col.foo `__) 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col1/index.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | 4 | Ns.Col1 5 | ======= 6 | 7 | 8 | .. contents:: 9 | :local: 10 | :depth: 1 11 | 12 | Description 13 | ----------- 14 | 15 | A short description. 16 | 17 | **Authors:** 18 | 19 | * Ansible (https://github.com/ansible) 20 | * Foo Bar (@ansible) 21 | * Test 22 | 23 | 24 | 25 | 26 | Changelog 27 | --------- 28 | 29 | `Ns.Col1 Release Notes `_ 30 | 31 | Plugin Index 32 | ------------ 33 | 34 | There are no plugins in the ns.col1 collection with automatically generated documentation. 35 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_cache.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra cache 4 | +++++++++++++++++++ 5 | 6 | The documentation for the cache plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 4 validation errors for PluginDocSchema 13 | doc -> options -> _uri -> env -> 0 -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> options -> _uri -> ini -> 0 -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | doc -> options -> _uri -> extra 18 | Extra inputs are not permitted (type=extra_forbidden) 19 | doc -> extra 20 | Extra inputs are not permitted (type=extra_forbidden) 21 | 22 | 23 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 24 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_callback.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra callback 4 | ++++++++++++++++++++++ 5 | 6 | The documentation for the callback plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 2 validation errors for CallbackDocSchema 13 | doc -> options -> bar -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | 18 | 19 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_cliconf.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra cliconf 4 | +++++++++++++++++++++ 5 | 6 | The documentation for the cliconf plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 1 validation error for PluginDocSchema 13 | doc -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | 16 | 17 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 18 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_connection.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra connection 4 | ++++++++++++++++++++++++ 5 | 6 | The documentation for the connection plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 3 validation errors for PluginDocSchema 13 | doc -> options -> host -> vars -> 0 -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> options -> host -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | doc -> extra 18 | Extra inputs are not permitted (type=extra_forbidden) 19 | 20 | 21 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 22 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_filter.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra filter 4 | ++++++++++++++++++++ 5 | 6 | The documentation for the filter plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 2 validation errors for PositionalDocSchema 13 | doc -> options -> _input -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | 18 | 19 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_inventory.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra inventory 4 | +++++++++++++++++++++++ 5 | 6 | The documentation for the inventory plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 2 validation errors for PluginDocSchema 13 | doc -> options -> bar -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | 18 | 19 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_lookup.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra lookup 4 | ++++++++++++++++++++ 5 | 6 | The documentation for the lookup plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 2 validation errors for PositionalDocSchema 13 | doc -> options -> _terms -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | 18 | 19 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_shell.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra shell 4 | +++++++++++++++++++ 5 | 6 | The documentation for the shell plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 5 validation errors for PluginDocSchema 13 | doc -> options -> remote_tmp -> env -> 0 -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> options -> remote_tmp -> ini -> 0 -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | doc -> options -> remote_tmp -> vars -> 0 -> extra 18 | Extra inputs are not permitted (type=extra_forbidden) 19 | doc -> options -> remote_tmp -> extra 20 | Extra inputs are not permitted (type=extra_forbidden) 21 | doc -> extra 22 | Extra inputs are not permitted (type=extra_forbidden) 23 | 24 | 25 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_strategy.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra strategy 4 | ++++++++++++++++++++++ 5 | 6 | The documentation for the strategy plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 1 validation error for PluginDocSchema 13 | doc -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | 16 | 17 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 18 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_test.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra test 4 | ++++++++++++++++++ 5 | 6 | The documentation for the test plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 2 validation errors for PositionalDocSchema 13 | doc -> options -> _input -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | 18 | 19 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/col2/extra_vars.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns.col2.extra vars 4 | ++++++++++++++++++ 5 | 6 | The documentation for the vars plugin, ns.col2.extra, was malformed. 7 | 8 | The errors were: 9 | 10 | * :: 11 | 12 | 4 validation errors for PluginDocSchema 13 | doc -> options -> _valid_extensions -> env -> 0 -> extra 14 | Extra inputs are not permitted (type=extra_forbidden) 15 | doc -> options -> _valid_extensions -> ini -> 0 -> extra 16 | Extra inputs are not permitted (type=extra_forbidden) 17 | doc -> options -> _valid_extensions -> extra 18 | Extra inputs are not permitted (type=extra_forbidden) 19 | doc -> extra 20 | Extra inputs are not permitted (type=extra_forbidden) 21 | 22 | 23 | File a bug with the `ns.col2 collection `_ in order to have it corrected. 24 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns/index.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | 4 | .. _list_of_collections_ns: 5 | 6 | Collections in the Ns Namespace 7 | =============================== 8 | 9 | These are the collections documented here in the **ns** namespace. 10 | 11 | * `ns.col1 `_ 12 | * `ns.col2 `_ 13 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/changelog.rst: -------------------------------------------------------------------------------- 1 | The changelog of ns2.col is empty. -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/docsite/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/foo_1_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_1_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_1_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/foo_2_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_2_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_2_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/foo_3_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_3_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_3_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo2 module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/foo_4_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_4_redirect 4 | ++++++++++++++++++++++ 5 | 6 | This plugin was part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | This module has been removed 9 | in version 2.0.0 of ns2.col. 10 | It is gone 11 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/foo_5_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_5_redirect module 4 | +++++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | 9 | - This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. 10 | It will be removed in version 5.0.0 of ns2.col. 11 | - This is a redirect to the ns2.col.foo2 module. 12 | - This redirect does **not** work with Ansible 2.9. 13 | - The collection contains the following information on this deprecation: It will be really gone 14 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/foo_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.foo_redirect module 4 | +++++++++++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.foo_redirect``. 9 | 10 | - This is a redirect to the ns2.col.foo module. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/col/is_bar_test.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | ns2.col.is_bar test 4 | +++++++++++++++++++ 5 | 6 | - This redirect is part of the `ns2.col collection `_ (version 2.1.0). 7 | 8 | To use it in a playbook, specify: ``ns2.col.is_bar``. 9 | 10 | - This is a redirect to the ns2.col.bar test plugin. 11 | - This redirect does **not** work with Ansible 2.9. 12 | -------------------------------------------------------------------------------- /tests/functional/baseline-simplified-rst/collections/ns2/index.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | 4 | .. _list_of_collections_ns2: 5 | 6 | Collections in the Ns2 Namespace 7 | ================================ 8 | 9 | These are the collections documented here in the **ns2** namespace. 10 | 11 | * `ns2.col `_ 12 | * `ns2.flatcol `_ 13 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-collections/.gitignore: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | /build 8 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-collections/build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | # Created with antsibull-docs 7 | 8 | set -e 9 | 10 | pushd "$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" 11 | trap "{ popd; }" EXIT 12 | 13 | # Create collection documentation 14 | mkdir -p rst 15 | chmod og-w rst # antsibull-docs wants that directory only readable by itself 16 | antsibull-docs \ 17 | --config-file antsibull-docs.cfg \ 18 | collection \ 19 | --cleanup everything \ 20 | --output-format ansible-docsite \ 21 | --dest-dir rst \ 22 | ns.col1 ns.col2 ns2.col 23 | 24 | # Build Sphinx site 25 | sphinx-build -M html rst build -c . -W --keep-going 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-collections/requirements.txt: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | antsibull-docs >= 2.0.0, < 3.0.0 8 | ansible-pygments 9 | sphinx 10 | sphinx-ansible-theme >= 0.9.0 11 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-collections/rst/index.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | .. _docsite_root_index: 4 | 5 | Welcome to my Ansible collection documentation 6 | ============================================== 7 | 8 | This docsite contains documentation of ns.col1, ns.col2, and ns2.col. 9 | 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | :caption: Collections: 14 | 15 | collections/index 16 | 17 | 18 | .. toctree:: 19 | :maxdepth: 1 20 | :caption: Plugin indexes: 21 | :glob: 22 | 23 | collections/index_* 24 | 25 | 26 | .. toctree:: 27 | :maxdepth: 1 28 | :caption: Reference indexes: 29 | 30 | collections/environment_variables 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-config/.gitignore: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | /build 8 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-config/build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | # Created with antsibull-docs 7 | 8 | set -e 9 | 10 | pushd "$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" 11 | trap "{ popd; }" EXIT 12 | 13 | # Create collection documentation 14 | mkdir -p rst 15 | chmod og-w rst # antsibull-docs wants that directory only readable by itself 16 | antsibull-docs \ 17 | --config-file antsibull-docs.cfg \ 18 | collection \ 19 | --cleanup everything \ 20 | --fail-on-error \ 21 | --squash-hierarchy \ 22 | --output-format ansible-docsite \ 23 | --dest-dir rst \ 24 | ns.col1 25 | 26 | # Build Sphinx site 27 | sphinx-build -M html rst build -c . 28 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-config/requirements.txt: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | antsibull-docs >= 2.0.0, < 3.0.0 8 | ansible-pygments 9 | sphinx 10 | another-theme 11 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-config/rst/index.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | Replacement index 7 | ================= 8 | 9 | This is a replacement index. 10 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-current/.gitignore: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | /build 8 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-current/build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | # Created with antsibull-docs 7 | 8 | set -e 9 | 10 | pushd "$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" 11 | trap "{ popd; }" EXIT 12 | 13 | # Create collection documentation 14 | mkdir -p rst 15 | chmod og-w rst # antsibull-docs wants that directory only readable by itself 16 | antsibull-docs \ 17 | --config-file antsibull-docs.cfg \ 18 | current \ 19 | --cleanup everything \ 20 | --dest-dir rst 21 | 22 | # Build Sphinx site 23 | sphinx-build -M html rst build -c . -W --keep-going 24 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-current/requirements.txt: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | antsibull-docs >= 2.0.0, < 3.0.0 8 | ansible-pygments 9 | sphinx 10 | sphinx-ansible-theme >= 0.9.0 11 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-current/rst/index.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | .. _docsite_root_index: 4 | 5 | Welcome to my Ansible collection documentation 6 | ============================================== 7 | 8 | This docsite contains documentation of some collections. 9 | 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | :caption: Collections: 14 | 15 | collections/index 16 | 17 | 18 | .. toctree:: 19 | :maxdepth: 1 20 | :caption: Plugin indexes: 21 | :glob: 22 | 23 | collections/index_* 24 | 25 | 26 | .. toctree:: 27 | :maxdepth: 1 28 | :caption: Reference indexes: 29 | 30 | collections/environment_variables 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-extra/.gitignore: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | /build 8 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-extra/build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | # Created with antsibull-docs 7 | 8 | set -e 9 | 10 | pushd "$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" 11 | trap "{ popd; }" EXIT 12 | 13 | # Create collection documentation 14 | mkdir -p rst 15 | chmod og-w rst # antsibull-docs wants that directory only readable by itself 16 | antsibull-docs \ 17 | --config-file antsibull-docs.cfg \ 18 | collection \ 19 | --cleanup everything \ 20 | --output-format ansible-docsite \ 21 | --dest-dir rst \ 22 | ns.col1 23 | 24 | # Build Sphinx site 25 | sphinx-build -M html rst build -c . -W --keep-going 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-extra/requirements.txt: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | # Created with antsibull-docs 6 | 7 | antsibull-docs >= 2.0.0, < 3.0.0 8 | ansible-pygments 9 | sphinx 10 | sphinx-ansible-theme >= 0.9.0 11 | -------------------------------------------------------------------------------- /tests/functional/baseline-sphinx-init-extra/rst/index.rst: -------------------------------------------------------------------------------- 1 | .. Created with antsibull-docs 2 | 3 | .. _docsite_root_index: 4 | 5 | Welcome to my Ansible collection documentation 6 | ============================================== 7 | 8 | This docsite contains documentation of ns.col1. 9 | 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | :caption: Collections: 14 | 15 | collections/index 16 | 17 | 18 | .. toctree:: 19 | :maxdepth: 1 20 | :caption: Plugin indexes: 21 | :glob: 22 | 23 | collections/index_* 24 | 25 | 26 | .. toctree:: 27 | :maxdepth: 1 28 | :caption: Reference indexes: 29 | 30 | collections/environment_variables 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/changelog.rst: -------------------------------------------------------------------------------- 1 | The changelog of ns2.col is empty. -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/docsite/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/foo_1_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_1_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_1_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/foo_2_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_2_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_2_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/foo_3_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_3_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_3_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/foo_4_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_4_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_4_redirect 15 | ++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This plugin was part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | This module has been removed 23 | in version 2.0.0 of ns2.col. 24 | It is gone 25 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/foo_5_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_5_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_5_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | 23 | - This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. 24 | It will be removed in version 5.0.0 of ns2.col. 25 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 26 | - This redirect does **not** work with Ansible 2.9. 27 | - The collection contains the following information on this deprecation: It will be really gone 28 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/foo_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_redirect module 15 | +++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-squash-hierarchy/is_bar_test.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.is_bar_test: 11 | 12 | .. Title 13 | 14 | ns2.col.is_bar test 15 | +++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.is_bar`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.bar test plugin `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/callback_index_stdout.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_stdout_callback_plugins: 7 | 8 | Index of all Stdout Callback Plugins 9 | ==================================== 10 | 11 | See :ref:`list_of_callback_plugins` for the list of *all* callback plugins. 12 | 13 | ns2.col 14 | ------- 15 | 16 | * :ansplugin:`ns2.col.foo#callback` -- Foo output :ansopt:`ns2.col.foo#callback:bar` 17 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_collections: 7 | 8 | Collection Index 9 | ================ 10 | 11 | These are the collections documented here. 12 | 13 | * :ref:`ns2.col ` 14 | 15 | .. toctree:: 16 | :maxdepth: 1 17 | :hidden: 18 | 19 | ns2/index 20 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_become.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_become_plugins: 7 | 8 | Index of all Become Plugins 9 | =========================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#become` -- Use foo :ansopt:`ns2.col.foo#become:bar` :ansdeprecatedmarker:`{"date": "", "version": "5.0.0"}` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_cache.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_cache_plugins: 7 | 8 | Index of all Cache Plugins 9 | ========================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#cache` -- Foo files :ansopt:`ns2.col.foo#cache:bar` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_callback.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_callback_plugins: 7 | 8 | Index of all Callback Plugins 9 | ============================= 10 | 11 | .. toctree:: 12 | :maxdepth: 1 13 | :caption: List of callback plugins by callback type 14 | :glob: 15 | 16 | callback_index_* 17 | 18 | 19 | ns2.col 20 | ------- 21 | 22 | * :ansplugin:`ns2.col.foo#callback` -- Foo output :ansopt:`ns2.col.foo#callback:bar` 23 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_cliconf.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_cliconf_plugins: 7 | 8 | Index of all Cliconf Plugins 9 | ============================ 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#cliconf` -- Foo router CLI config 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_connection.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_connection_plugins: 7 | 8 | Index of all Connection Plugins 9 | =============================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#connection` -- Foo connection :ansopt:`ns2.col.foo#connection:bar` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_filter.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_filter_plugins: 7 | 8 | Index of all Filter Plugins 9 | =========================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.bar#filter` -- The bar filter 15 | * :ansplugin:`ns2.col.foo#filter` -- The foo filter :ansopt:`ns2.col.foo#filter:bar` 16 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_inventory.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_inventory_plugins: 7 | 8 | Index of all Inventory Plugins 9 | ============================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#inventory` -- The foo inventory :ansopt:`ns2.col.foo#inventory:bar` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_lookup.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_lookup_plugins: 7 | 8 | Index of all Lookup Plugins 9 | =========================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#lookup` -- Look up some foo :ansopt:`ns2.col.foo#lookup:bar` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_module.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_module_plugins: 7 | 8 | Index of all Modules 9 | ==================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#module` -- Do some foo :ansopt:`ns2.col.foo#module:bar` 15 | * :ansplugin:`ns2.col.foo2#module` -- Another foo 16 | * :ansplugin:`ns2.col.sub.foo3#module` -- A sub-foo 17 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_role.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_role_plugins: 7 | 8 | Index of all Roles 9 | ================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#role` -- Foo role :ansdeprecatedmarker:`{"date": "2020-01-01", "version": ""}` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_shell.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_shell_plugins: 7 | 8 | Index of all Shell Plugins 9 | ========================== 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#shell` -- Foo shell :ansopt:`ns2.col.foo#shell:bar` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_strategy.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_strategy_plugins: 7 | 8 | Index of all Strategy Plugins 9 | ============================= 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#strategy` -- Executes tasks in foo 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_test.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_test_plugins: 7 | 8 | Index of all Test Plugins 9 | ========================= 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.bar#test` -- Is something a bar 15 | * :ansplugin:`ns2.col.foo#test` -- Is something a foo :ansopt:`ns2.col.foo#test:bar` 16 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/index_vars.rst: -------------------------------------------------------------------------------- 1 | :orphan: 2 | 3 | .. meta:: 4 | :antsibull-docs: 5 | 6 | .. _list_of_vars_plugins: 7 | 8 | Index of all Vars Plugins 9 | ========================= 10 | 11 | ns2.col 12 | ------- 13 | 14 | * :ansplugin:`ns2.col.foo#vars` -- Load foo :ansopt:`ns2.col.foo#vars:bar` 15 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/changelog.rst: -------------------------------------------------------------------------------- 1 | The changelog of ns2.col is empty. -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/docsite/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_1_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_1_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_1_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_1_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_2_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_2_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_2_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_2_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_3_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_3_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_3_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_3_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_4_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_4_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_4_redirect 15 | ++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This plugin was part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | This module has been removed 23 | in version 2.0.0 of ns2.col. 24 | It is gone 25 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_5_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_5_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_5_redirect module 15 | +++++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | 23 | - This redirect has been **deprecated**. Please update your tasks to use the new name ``ns2.col.foo2`` instead. 24 | It will be removed in version 5.0.0 of ns2.col. 25 | - This is a redirect to the :ansplugin:`ns2.col.foo2 module `. 26 | - This redirect does **not** work with Ansible 2.9. 27 | - The collection contains the following information on this deprecation: It will be really gone 28 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_redirect_module.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.foo_redirect_module: 11 | 12 | .. Title 13 | 14 | ns2.col.foo_redirect module 15 | +++++++++++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.foo_redirect`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.foo module `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/col/is_bar_test.rst: -------------------------------------------------------------------------------- 1 | .. Document meta 2 | 3 | :orphan: 4 | 5 | .. meta:: 6 | :antsibull-docs: 7 | 8 | .. Anchors 9 | 10 | .. _ansible_collections.ns2.col.is_bar_test: 11 | 12 | .. Title 13 | 14 | ns2.col.is_bar test 15 | +++++++++++++++++++ 16 | 17 | .. Collection note 18 | 19 | .. note:: 20 | This redirect is part of the `ns2.col collection `_ (version 2.1.0). 21 | 22 | To use it in a playbook, specify: :code:`ns2.col.is_bar`. 23 | 24 | - This is a redirect to the :ansplugin:`ns2.col.bar test plugin `. 25 | - This redirect does **not** work with Ansible 2.9. 26 | -------------------------------------------------------------------------------- /tests/functional/baseline-use-html-blobs/collections/ns2/index.rst: -------------------------------------------------------------------------------- 1 | .. meta:: 2 | :antsibull-docs: 3 | 4 | .. _list_of_collections_ns2: 5 | 6 | Collections in the Ns2 Namespace 7 | ================================ 8 | 9 | These are the collections documented here in the **ns2** namespace. 10 | 11 | * :ref:`ns2.col ` 12 | 13 | .. toctree:: 14 | :maxdepth: 1 15 | :hidden: 16 | 17 | col/index 18 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col1/COPYING: -------------------------------------------------------------------------------- 1 | ../../../../../../LICENSE -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col1/docs/docsite/config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | changelog: 7 | write_changelog: true 8 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col1/galaxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | namespace: ns 7 | name: col1 8 | version: null 9 | readme: README.md 10 | authors: 11 | - Ansible (https://github.com/ansible) 12 | - Foo Bar (@ansible) 13 | - Test 14 | description: A short description. 15 | license_file: COPYING 16 | tags: [] 17 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col1/plugins/module_utils/empty.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | 10 | def empty(): 11 | pass 12 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/COPYING: -------------------------------------------------------------------------------- 1 | ../../../../../../LICENSE -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/docs/docsite/config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | flatmap: 42 7 | 8 | bla: 9 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/docs/docsite/extra-docs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | sections: 7 | - title: Guides 8 | toctree: Test 9 | - foo: bar 10 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/docs/docsite/links.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | edit_on_github: 7 | branch: main 8 | path_prefi: tests/functional/collections/ansible_collections/ns/col2 9 | extra: more 10 | 11 | extra: crap 12 | 13 | extra_link: 14 | - description: Submit a bug report 15 | url: https://github.com/ansible-community/antsibull-docs/issues/new?assignees=&labels=&template=bug_report.md 16 | extra: more 17 | 18 | extra_links: 19 | foo: bar 20 | 21 | communication: 22 | matrix_rooms: 23 | - extra: foo 24 | name: bar 25 | room: baz 26 | irc_channels: 27 | - topic: 42 28 | network: true 29 | extra: foo 30 | mailing_lists: 31 | - name: Ansible Project List 32 | extra: bar 33 | forums: 34 | - topic: foo 35 | extra: baz 36 | 37 | bla: 38 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/docs/docsite/rst/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _bad_label: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers no filters. 16 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/galaxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | namespace: ns 7 | name: col2 8 | version: 0.0.1 9 | readme: README.md 10 | authors: 11 | - Ansible (https://github.com/ansible) 12 | dependencies: 13 | ns2.col: '>= 1.0.0' 14 | license_file: COPYING 15 | tags: [community, nothing] 16 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/meta/runtime.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | requires_ansible: '>2.11.0' 7 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/plugins/callback/extra.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | name: extra 11 | type: stdout 12 | short_description: Some extra 13 | version_added: 0.0.1 14 | description: 15 | - Absolut minimal foo output. 16 | extra: Ja. 17 | options: 18 | bar: 19 | description: Nothing. 20 | type: string 21 | extra: More. 22 | """ 23 | 24 | from ansible.plugins.callback import CallbackBase 25 | 26 | 27 | class CallbackModule(CallbackBase): 28 | CALLBACK_VERSION = 2.0 29 | CALLBACK_TYPE = "stdout" 30 | CALLBACK_NAME = "ns2.col.extra" 31 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/plugins/cliconf/extra.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | --- 11 | author: "Felix Fontein (@felixfontein) " 12 | name: extra 13 | short_description: Extra routing 14 | description: 15 | - This is a CLI config for foo routers. Whatever these are. 16 | extra: More extra. 17 | """ 18 | 19 | from ansible.plugins.cliconf import CliconfBase 20 | 21 | 22 | class Cliconf(CliconfBase): 23 | pass 24 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/plugins/filter/extra.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | 10 | DOCUMENTATION = r""" 11 | name: extra 12 | version_added: 1.3.0 13 | short_description: The foo filter O(bar) 14 | description: 15 | - Do some fooing. 16 | extra: nope 17 | options: 18 | _input: 19 | description: The main input. 20 | type: str 21 | required: true 22 | extra: Yeah. 23 | """ 24 | 25 | EXAMPLES = r""" 26 | some_var: "{{ 'foo' | ns2.col.extra }}" 27 | """ 28 | 29 | RETURN = r""" 30 | _value: 31 | description: The result. 32 | type: str 33 | """ 34 | 35 | 36 | def extra(input): 37 | return "FOO:{0}:BAR".format(input) 38 | 39 | 40 | class FilterModule(object): 41 | def filters(self): 42 | return { 43 | "extra": extra, 44 | } 45 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/plugins/inventory/extra.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | name: extra 11 | version_added: 0.5.0 12 | short_description: The extra inventory 13 | description: 14 | - Loads inventory from foo. 15 | extra: Toplevel. 16 | options: 17 | bar: 18 | description: Foo bar. 19 | type: string 20 | extra: Option. 21 | """ 22 | 23 | EXAMPLES = """ 24 | foo: 25 | bar! 26 | """ 27 | 28 | from ansible.plugins.inventory import BaseFileInventoryPlugin 29 | 30 | 31 | class InventoryModule(BaseFileInventoryPlugin): 32 | NAME = "ns2.col.extra" 33 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/plugins/strategy/extra.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | name: extra 11 | short_description: Executes tasks in foo 12 | description: 13 | - This is something funny. Or at least I think so from its name. 14 | version_added: 1.1.0 15 | author: Ansible Core Team 16 | extra: more 17 | """ 18 | 19 | from ansible.plugins.strategy import StrategyBase 20 | 21 | 22 | class StrategyModule(StrategyBase): 23 | ALLOW_BASE_THROTTLING = False 24 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/roles/bar/meta/argument_specs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | argument_specs: 7 | main: 8 | short_description: Bar role 9 | description: 10 | - This is the bar role. 11 | author: 12 | - Felix Fontein (@felixfontein) 13 | seealso: 14 | - module: ns2.col.foo 15 | - module: ns2.col.foobarbaz 16 | # does not exist 17 | - plugin: ns2.col.foo 18 | plugin_type: lookup 19 | baz: 20 | short_description: Bar role, baz entrypoint テストロール 21 | description: 22 | - This is the baz entrypoint of the bar role. 23 | examples: An example. 24 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/roles/bar/meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | galaxy_info: 7 | standalone: false 8 | description: Bar role. 9 | 10 | dependencies: [] 11 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/roles/bar/tasks/baz.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | - ansible.builtin.debug: 7 | msg: Hi baz. 8 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/roles/bar/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | - ansible.builtin.debug: 7 | msg: Hi main. 8 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/roles/extra/meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | galaxy_info: 7 | standalone: false 8 | description: Bar role. 9 | extra: foo 10 | 11 | extra: bar 12 | 13 | dependencies: [] 14 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/roles/extra/tasks/baz.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | - ansible.builtin.debug: 7 | msg: Hi baz. 8 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns/col2/roles/extra/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | - ansible.builtin.debug: 7 | msg: Hi main. 8 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/COPYING: -------------------------------------------------------------------------------- 1 | ../../../../../../LICENSE -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/changelogs/changelog.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | releases: 7 | - 1 8 | - 2 9 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/docs/docsite/config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | envvar_directives: 7 | - FOOBAR1 8 | - FOOBAR2 9 | 10 | changelog: 11 | write_changelog: true 12 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/docs/docsite/extra-docs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | sections: 7 | - title: Guides 8 | toctree: 9 | - filter_guide 10 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/docs/docsite/rst/filter_guide.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | .. _ansible_collections.ns2.col.docsite.filter_guide: 7 | 8 | Filter Guide 9 | ============ 10 | 11 | .. contents:: Contents 12 | :local: 13 | :depth: 1 14 | 15 | The :ref:`ns2.col collection ` offers two filters. 16 | 17 | - ``ns2.col.foo``: foo! 18 | - ``ns2.col.bar``: bar! 19 | 20 | .. envvar:: FOOBAR1 21 | 22 | This is one environment variable. 23 | 24 | .. envvar:: FOOBAR2 25 | 26 | This is another environment variable. 27 | 28 | .. envvar:: FOOBAR3 29 | 30 | This is a third environment variable. 31 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/galaxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | namespace: ns2 7 | name: col 8 | version: 2.1.0 9 | readme: README.md 10 | authors: 11 | - Ansible (https://github.com/ansible) 12 | description: | 13 | This is a description. 14 | 15 | With multiple paragraphs. 16 | license_file: COPYING 17 | tags: [community, foo, bar] 18 | repository: https://github.com/ansible-collections/community.internal_test_tools 19 | documentation: https://docs.ansible.com/ansible/latest/collections/community/docker/ 20 | homepage: https://github.com/ansible-collections/community.crypto 21 | issues: https://github.com/ansible-collections/community.general/issues 22 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | name: foo 11 | type: stdout 12 | short_description: Foo output O(bar) 13 | version_added: 0.0.1 14 | description: 15 | - Absolut minimal foo output. 16 | options: 17 | bar: 18 | description: Nothing. 19 | type: string 20 | """ 21 | 22 | from ansible.plugins.callback import CallbackBase 23 | 24 | 25 | class CallbackModule(CallbackBase): 26 | CALLBACK_VERSION = 2.0 27 | CALLBACK_TYPE = "stdout" 28 | CALLBACK_NAME = "ns2.col.foo" 29 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/cliconf/foo.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | --- 11 | author: "Felix Fontein (@felixfontein) " 12 | name: foo 13 | short_description: Foo router CLI config 14 | description: 15 | - This is a CLI config for foo routers. Whatever these are. 16 | """ 17 | 18 | from ansible.plugins.cliconf import CliconfBase 19 | 20 | 21 | class Cliconf(CliconfBase): 22 | pass 23 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/filter/bar.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | 10 | def bar(input, foo, bar, baz): 11 | return input | foo 12 | 13 | 14 | class FilterModule(object): 15 | def filters(self): 16 | return { 17 | "bar": bar, 18 | } 19 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/inventory/foo.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | name: foo 11 | version_added: 0.5.0 12 | short_description: The foo inventory O(bar) 13 | description: 14 | - Loads inventory from foo. 15 | options: 16 | bar: 17 | description: Foo bar. 18 | type: string 19 | """ 20 | 21 | EXAMPLES = """ 22 | foo: 23 | bar! 24 | """ 25 | 26 | from ansible.plugins.inventory import BaseFileInventoryPlugin 27 | 28 | 29 | class InventoryModule(BaseFileInventoryPlugin): 30 | NAME = "ns2.col.foo" 31 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/strategy/foo.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | DOCUMENTATION = """ 10 | name: foo 11 | short_description: Executes tasks in foo 12 | description: 13 | - This is something funny. Or at least I think so from its name. 14 | version_added: 1.1.0 15 | author: Ansible Core Team 16 | """ 17 | 18 | from ansible.plugins.strategy import StrategyBase 19 | 20 | 21 | class StrategyModule(StrategyBase): 22 | ALLOW_BASE_THROTTLING = False 23 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/test/bar.py: -------------------------------------------------------------------------------- 1 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | # SPDX-FileCopyrightText: Ansible Project 4 | 5 | from __future__ import absolute_import, division, print_function 6 | 7 | __metaclass__ = type 8 | 9 | 10 | def bar(input): 11 | return False 12 | 13 | 14 | class TestModule(object): 15 | def tests(self): 16 | return { 17 | "bar": bar, 18 | "is_bar": bar, 19 | } 20 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/test/bar.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | DOCUMENTATION: 7 | name: bar 8 | author: Ansible Core 9 | short_description: Is something a bar 10 | aliases: 11 | - is_bar 12 | description: 13 | - Check whether a path is a bar. 14 | options: 15 | _input: 16 | description: A path. 17 | type: path 18 | 19 | EXAMPLES: | 20 | is_path_bar: "{{ '/etc/hosts' is ns2.col.bar }}}" 21 | 22 | RETURN: 23 | _value: 24 | description: Returns C(true) if the path is a bar, C(false) if it is not a bar. 25 | type: boolean 26 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/plugins/test/is_bar.yml: -------------------------------------------------------------------------------- 1 | bar.yml -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/roles/foo/meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | galaxy_info: 7 | standalone: false 8 | description: Foo role. 9 | 10 | dependencies: [] 11 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/col/roles/foo/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | # SPDX-FileCopyrightText: Ansible Project 5 | 6 | - ansible.builtin.debug: 7 | msg: Hi. 8 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/flatcol/COPYING: -------------------------------------------------------------------------------- 1 | ../../../../../../LICENSE -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/flatcol/docs/docsite/config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | flatmap: true 7 | -------------------------------------------------------------------------------- /tests/functional/collections/ansible_collections/ns2/flatcol/galaxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | namespace: ns2 7 | name: flatcol 8 | version: 9 | readme: README.md 10 | authors: 11 | - Ansible (https://github.com/ansible) 12 | -------------------------------------------------------------------------------- /tests/functional/other-collections/ansible_collections/ext/col/galaxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | namespace: ext 7 | name: col 8 | version: 3.0.0 9 | readme: README.md 10 | authors: 11 | - Ansible (https://github.com/ansible) 12 | description: | 13 | This is a description. 14 | 15 | With multiple paragraphs. 16 | license: GPL-3.0-or-later 17 | tags: [external, stuff] 18 | -------------------------------------------------------------------------------- /tests/functional/sanitize-ansible-galaxy-list.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | from __future__ import annotations 7 | 8 | import json 9 | import os 10 | import sys 11 | 12 | root = os.path.join(os.getcwd(), "collections") 13 | other_root = os.path.join(os.getcwd(), "other-collections") 14 | data = json.load(sys.stdin) 15 | result = {} 16 | for path, collections in data.items(): 17 | rel_root = os.path.relpath(path, root) 18 | if rel_root.startswith(".") and not rel_root.startswith("../other-collections/"): 19 | raise Exception(f"Cannot sanitize {doc[key]}") 20 | result[rel_root] = collections 21 | json.dump(result, sys.stdout, indent=1, sort_keys=True) 22 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_become.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_become_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_cache.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_cache_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_callback.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_callback_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_cliconf.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_cliconf_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_connection.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_connection_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_filter.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_filter_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_httpapi.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_httpapi_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_inventory.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_inventory_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_lookup.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_lookup_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_module.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_module_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_netconf.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_netconf_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_role.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_role_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_shell.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_shell_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_strategy.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_strategy_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_test.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_test_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_vars.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/one_vars_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/ssh_connection.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/schema/good_data/ssh_connection_results.json.license: -------------------------------------------------------------------------------- 1 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 2 | SPDX-FileCopyrightText: Ansible Project 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | -------------------------------------------------------------------------------- /tests/functional/test.rst: -------------------------------------------------------------------------------- 1 | .. 2 | Copyright (c) Ansible Project 3 | GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | Replacement index 7 | ================= 8 | 9 | This is a replacement index. 10 | -------------------------------------------------------------------------------- /tests/functional/utils.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Ansible Project 2 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 3 | # SPDX-License-Identifier: GPL-3.0-or-later 4 | 5 | from __future__ import annotations 6 | 7 | from contextlib import contextmanager 8 | from unittest import mock 9 | 10 | import antsibull_docs 11 | 12 | ANTSIBULL_DOCS_CI_VERSION = "" 13 | 14 | 15 | @contextmanager 16 | def replace_antsibull_version(new_version=ANTSIBULL_DOCS_CI_VERSION): 17 | with mock.patch( 18 | "antsibull_docs.__version__", 19 | new_version, 20 | ): 21 | yield 22 | -------------------------------------------------------------------------------- /tests/validate-html.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # Copyright (c) Ansible Project 3 | # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | from __future__ import annotations 7 | 8 | import os 9 | import sys 10 | 11 | import html5lib 12 | 13 | errors = 0 14 | for path in sys.argv[1:]: 15 | for dirname, _, files in os.walk(path): 16 | for file in files: 17 | if not file.endswith(".html"): 18 | continue 19 | path = os.path.join(dirname, file) 20 | try: 21 | parser = html5lib.HTMLParser(strict=True) 22 | with open(path, "rb") as f: 23 | document = parser.parse(f) 24 | except Exception as e: 25 | errors += 1 26 | print(f"{path}: {e}") 27 | 28 | if errors > 0: 29 | print(f"Found {errors} errors!") 30 | sys.exit(1) 31 | --------------------------------------------------------------------------------