Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix errors in module documentation #26

Open
lego963 opened this issue Apr 12, 2022 · 2 comments
Open

Fix errors in module documentation #26

lego963 opened this issue Apr 12, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@lego963
Copy link
Contributor

lego963 commented Apr 12, 2022

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 lego963 added the documentation Improvements or additions to documentation label Apr 12, 2022
@lego963
Copy link
Contributor Author

lego963 commented Apr 14, 2022

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
Copy link
Member

gtema commented Apr 15, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants