ansible / ansible

Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy and maintain. Automate everything from code deployment to network configuration to cloud management, in a language that approaches plain English, using SSH, with no agents to install on remote systems. https://docs.ansible.com.
https://www.ansible.com/
GNU General Public License v3.0
61.75k stars 23.75k forks source link

Fix a validation error that occurs during Sphinx build #83495

Closed oraNod closed 6 days ago

oraNod commented 6 days ago
SUMMARY

Resolves https://github.com/ansible/ansible-documentation/issues/1648

This change fixes a validation error in the docstring for the package_facts module. This error occurs during Sphinx docs build:

ansible-documentation/docs/docsite/rst/collections/ansible/builtin/package_facts_module.rst:28: WARNING: Lexing literal_block '1 validation error for ModuleDocSchema\ndoc -> options -> manager -> __root__\n  Invalid value {\'apk\': [\'Alpine Linux package manager\'], \'apt\': [\'For DEB based distros, C(python-apt) package must be installed on targeted hosts\'], \'auto\': [\'Depending on O(strategy), will match the first or all package managers provided, in order\'], \'dnf\': [\'Alias to rpm\'], \'dnf5\': [\'Alias to rpm\'], \'openbsd_pkg\': [\'Alias to pkg_info\'], \'pacman\': [\'Archlinux package manager/builder\'], \'pkg\': [\'libpkg front end (FreeBSD)\'], \'pkg5\': [\'Alias to pkg\'], \'pkg_info\': [\'OpenBSD package manager\'], \'pkgng\': [\'Alias to pkg\'], \'portage\': ["Handles ebuild packages, it requires the C(qlist) utility, which is part of \'app-portage/portage-utils\'"], \'rpm\': [\'For RPM based distros, requires RPM Python bindings, not installed by default on Suse (python3-rpm)\'], \'yum\': [\'Alias to rpm\'], \'zypper\': [\'Alias to rpm\']} for "choices": <class \'dict\'> cannot be converted to a list (type=value_error)' as "YAML+Jinja" resulted in an error at token: ','. Retrying in relaxed mode.
ISSUE TYPE
ADDITIONAL INFORMATION

The issue seems to have been introduced with https://github.com/ansible/ansible/pull/83149

bcoca commented 6 days ago

validation needs to be fixed instead, this is correct docs format.