summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Clay <matt@mystile.com>2023-04-06 09:58:49 -0700
committerGitHub <noreply@github.com>2023-04-06 09:58:49 -0700
commit13cdec1f46a0b43b4ca1cfac2771835986fc165f (patch)
treee5a0eae00211fcef5deeab1730419f5cec619653
parent66ef54e83fd7cfac8e4ab5e039cb06278b8ceaa4 (diff)
downloadansible-13cdec1f46a0b43b4ca1cfac2771835986fc165f.tar.gz
[stable-2.15] Extend ansible-doc test with more classic markup. (#80407) (#80431)
(cherry picked from commit 96f7fd5539f6124004fecef8f7110d4965686872) Co-authored-by: Felix Fontein <felix@fontein.de>
-rw-r--r--test/integration/targets/ansible-doc/collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py4
-rw-r--r--test/integration/targets/ansible-doc/randommodule-text.output7
-rw-r--r--test/integration/targets/ansible-doc/randommodule.output5
3 files changed, 14 insertions, 2 deletions
diff --git a/test/integration/targets/ansible-doc/collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py b/test/integration/targets/ansible-doc/collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py
index 71ae7c1145..aaaecb80f7 100644
--- a/test/integration/targets/ansible-doc/collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py
+++ b/test/integration/targets/ansible-doc/collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py
@@ -10,6 +10,10 @@ short_description: A random module
description:
- A random module.
- See O(foo.bar.baz#role:main:foo=bar) for how this is used in the P(foo.bar.baz#role)'s C(main) entrypoint.
+ - See L(the docsite,https://docs.ansible.com/ansible-core/devel/) for more information on ansible-core.
+ - This module is not related to the M(ansible.builtin.copy) module. HORIZONTALLINE You might also be interested
+ in R(ansible_python_interpreter, ansible_python_interpreter).
+ - Sometimes you have M(broken markup) that will result in error messages.
author:
- Ansible Core Team
version_added: 1.0.0
diff --git a/test/integration/targets/ansible-doc/randommodule-text.output b/test/integration/targets/ansible-doc/randommodule-text.output
index 5a7ff1ce9f..ca361346c0 100644
--- a/test/integration/targets/ansible-doc/randommodule-text.output
+++ b/test/integration/targets/ansible-doc/randommodule-text.output
@@ -2,7 +2,12 @@
A random module. See `foo=bar' (of role foo.bar.baz, main
entrypoint) for how this is used in the [foo.bar.baz]'s `main'
- entrypoint.
+ entrypoint. See the docsite <https://docs.ansible.com/ansible-
+ core/devel/> for more information on ansible-core. This module
+ is not related to the [ansible.builtin.copy] module.
+ ------------- You might also be interested in
+ ansible_python_interpreter. Sometimes you have [broken markup]
+ that will result in error messages.
ADDED IN: version 1.0.0 of testns.testcol
diff --git a/test/integration/targets/ansible-doc/randommodule.output b/test/integration/targets/ansible-doc/randommodule.output
index aad2cc4403..f40202a826 100644
--- a/test/integration/targets/ansible-doc/randommodule.output
+++ b/test/integration/targets/ansible-doc/randommodule.output
@@ -13,7 +13,10 @@
},
"description": [
"A random module.",
- "See O(foo.bar.baz#role:main:foo=bar) for how this is used in the P(foo.bar.baz#role)'s C(main) entrypoint."
+ "See O(foo.bar.baz#role:main:foo=bar) for how this is used in the P(foo.bar.baz#role)'s C(main) entrypoint.",
+ "See L(the docsite,https://docs.ansible.com/ansible-core/devel/) for more information on ansible-core.",
+ "This module is not related to the M(ansible.builtin.copy) module. HORIZONTALLINE You might also be interested in R(ansible_python_interpreter, ansible_python_interpreter).",
+ "Sometimes you have M(broken markup) that will result in error messages."
],
"filename": "./collections/ansible_collections/testns/testcol/plugins/modules/randommodule.py",
"has_action": false,