From dca7fd45528ade60c572df8aa38a3b409c29df35 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sat, 20 May 2023 13:05:44 +0200 Subject: [PATCH] Enable using semantic markup (#6539) Enable using semantic markup. --- changelogs/fragments/6539-semantic-markup.yml | 7 +++++++ tests/sanity/extra/extra-docs.py | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 changelogs/fragments/6539-semantic-markup.yml diff --git a/changelogs/fragments/6539-semantic-markup.yml b/changelogs/fragments/6539-semantic-markup.yml new file mode 100644 index 0000000000..9619cd3bee --- /dev/null +++ b/changelogs/fragments/6539-semantic-markup.yml @@ -0,0 +1,7 @@ +--- +minor_changes: + - "The collection will start using semantic markup (https://github.com/ansible-collections/community.general/pull/6539)." +known_issues: + - "Ansible markup will show up in raw form on ansible-doc text output for ansible-core before 2.15. If you have trouble deciphering the + documentation markup, please upgrade to ansible-core 2.15 (or newer), or read the HTML documentation on + https://docs.ansible.com/ansible/devel/collections/community/general/ (https://github.com/ansible-collections/community.general/pull/6539)." diff --git a/tests/sanity/extra/extra-docs.py b/tests/sanity/extra/extra-docs.py index c636beb08e..251e6d70f5 100755 --- a/tests/sanity/extra/extra-docs.py +++ b/tests/sanity/extra/extra-docs.py @@ -17,7 +17,7 @@ def main(): suffix = ':{env}'.format(env=env["ANSIBLE_COLLECTIONS_PATH"]) if 'ANSIBLE_COLLECTIONS_PATH' in env else '' env['ANSIBLE_COLLECTIONS_PATH'] = '{root}{suffix}'.format(root=os.path.dirname(os.path.dirname(os.path.dirname(os.getcwd()))), suffix=suffix) p = subprocess.run( - ['antsibull-docs', 'lint-collection-docs', '--plugin-docs', '--disallow-semantic-markup', '--skip-rstcheck', '.'], + ['antsibull-docs', 'lint-collection-docs', '--plugin-docs', '--skip-rstcheck', '.'], env=env, check=False, )