diff options
| author | Felix Fontein <felix@fontein.de> | 2023-03-23 18:28:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-23 13:28:05 -0400 |
| commit | fafb23094e77a619066a92a7fa99a7045292e473 (patch) | |
| tree | b333f16733c9ae7e4abd507f0c87bce1e9aea963 /lib | |
| parent | 4ea50cef23c3dc941b2e8dc507f37a962af6e2c8 (diff) | |
| download | ansible-fafb23094e77a619066a92a7fa99a7045292e473.tar.gz | |
ansible-doc: fix broken seealso links in text output (#80280)
* Fix broken URLs.
* Also remove auto-generated description for modules outside ansible.builtin.
Diffstat (limited to 'lib')
| -rwxr-xr-x | lib/ansible/cli/doc.py | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/lib/ansible/cli/doc.py b/lib/ansible/cli/doc.py index dfe27f64b3..54b328074f 100755 --- a/lib/ansible/cli/doc.py +++ b/lib/ansible/cli/doc.py @@ -1286,10 +1286,16 @@ class DocCLI(CLI, RoleMixin): if 'module' in item: text.append(textwrap.fill(DocCLI.tty_ify('Module %s' % item['module']), limit - 6, initial_indent=opt_indent[:-2] + "* ", subsequent_indent=opt_indent)) - description = item.get('description', 'The official documentation on the %s module.' % item['module']) - text.append(textwrap.fill(DocCLI.tty_ify(description), limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent + ' ')) - text.append(textwrap.fill(DocCLI.tty_ify(get_versioned_doclink('modules/%s_module.html' % item['module'])), - limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent)) + description = item.get('description') + if description is None and item['module'].startswith('ansible.builtin.'): + description = 'The official documentation on the %s module.' % item['module'] + if description is not None: + text.append(textwrap.fill(DocCLI.tty_ify(description), + limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent + ' ')) + if item['module'].startswith('ansible.builtin.'): + relative_url = 'collections/%s_module.html' % item['module'].replace('.', '/', 2) + text.append(textwrap.fill(DocCLI.tty_ify(get_versioned_doclink(relative_url)), + limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent)) elif 'name' in item and 'link' in item and 'description' in item: text.append(textwrap.fill(DocCLI.tty_ify(item['name']), limit - 6, initial_indent=opt_indent[:-2] + "* ", subsequent_indent=opt_indent)) |