Fix errors in module documentation
Opened this issue · 2 comments
lego963 commented
2022-04-12 15:33:23.128994 | TASK [antsibull-docs : Generate ansible modules documentation]
2022-04-12 15:33:26.933296 | fedora-pod | ERROR:antsibull:error=Missing documentation or could not parse documentation: while scanning a simple key\n in "<unicode string>", line 53, column 5\ncould not find expected ':'\n in "<unicode string>", line 54, column 5:func=get_ansible_plugin_info:mod=antsibull_docs.docs_parsing.ansible_internal:plugin_name=opentelekomcloud.gitcontrol.github_org_team:plugin_type=module|Error while extracting documentation. Will not document this plugin.
2022-04-12 15:33:27.064569 | fedora-pod | ERROR:antsibull:func=write_plugin_rst:mod=antsibull_docs.write_docs:nonfatal_errors=['1 validation error for ModuleDocSchema\ndoc -> options -> members -> suboptions -> role -> chocices\n extra fields not permitted (type=value_error.extra)']:plugin_name=opentelekomcloud.gitcontrol.github_org_members:plugin_type=module|opentelekomcloud.gitcontrol.github_org_members did not return correct DOCUMENTATION. An error page will be generated.
2022-04-12 15:33:27.065093 | fedora-pod | ERROR:antsibull:func=write_plugin_rst:mod=antsibull_docs.write_docs:nonfatal_errors=['5 validation errors for ModuleDocSchema\ndoc -> options -> branch_protection -> suboptions -> required_pull_request_reviews -> restrictions\n extra fields not permitted (type=value_error.extra)\ndoc -> options -> branch_protection -> elemetns\n extra fields not permitted (type=value_error.extra)\ndoc -> options -> collaborators -> options\n extra fields not permitted (type=value_error.extra)\ndoc -> options -> state -> chocies\n extra fields not permitted (type=value_error.extra)\ndoc -> options -> teams -> options\n extra fields not permitted (type=value_error.extra)']:plugin_name=opentelekomcloud.gitcontrol.github_org_repository:plugin_type=module|opentelekomcloud.gitcontrol.github_org_repository did not return correct DOCUMENTATION. An error page will be generated.
2022-04-12 15:33:27.065416 | fedora-pod | ERROR:antsibull:func=write_plugin_rst:mod=antsibull_docs.write_docs:nonfatal_errors=['Unable to normalize github_org_teams: return due to: 1 validation error for PluginReturnSchema\nreturn -> opentelekomcloud.gitcontrol.github_org_teams -> list_item\n extra fields not permitted (type=value_error.extra)']:plugin_name=opentelekomcloud.gitcontrol.github_org_teams:plugin_type=module|opentelekomcloud.gitcontrol.github_org_teams did not return correct RETURN or EXAMPLES.
2022-04-12 15:33:27.684662 | fedora-pod | ok: Runtime: 0:00:01.339074
lego963 commented
Some errors will be fixed in #28
022-04-14 13:21:24.072780 | TASK [antsibull-docs : Generate ansible modules documentation]
2022-04-14 13:21:27.945453 | fedora-pod | ERROR:antsibull:error=Missing documentation or could not parse documentation: while scanning a simple key\n in "<unicode string>", line 53, column 5\ncould not find expected ':'\n in "<unicode string>", line 54, column 5:func=get_ansible_plugin_info:mod=antsibull_docs.docs_parsing.ansible_internal:plugin_name=opentelekomcloud.gitcontrol.github_org_team:plugin_type=module|Error while extracting documentation. Will not document this plugin.
2022-04-14 13:21:28.102983 | fedora-pod | ERROR:antsibull:func=write_plugin_rst:mod=antsibull_docs.write_docs:nonfatal_errors=['3 validation errors for ModuleDocSchema\ndoc -> options -> branch_protection -> suboptions -> required_pull_request_reviews -> restrictions\n extra fields not permitted (type=value_error.extra)\ndoc -> options -> collaborators -> options\n extra fields not permitted (type=value_error.extra)\ndoc -> options -> teams -> options\n extra fields not permitted (type=value_error.extra)']:plugin_name=opentelekomcloud.gitcontrol.github_org_repository:plugin_type=module|opentelekomcloud.gitcontrol.github_org_repository did not return correct DOCUMENTATION. An error page will be generated.
2022-04-14 13:21:28.629817 | fedora-pod | ok: Runtime: 0:00:01.579278
gtema commented
Now we have module docs, but those are not included in the index.rst and are thus not findable. We need to fix that also. I would not spend too much time on theming or whatever else tuning of the doc itself, just ensure docs are properly present in the doc tree