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
SSH connection plugin docs are broken #74838
SSH connection plugin docs are broken #74838
Comments
Files identified in the description: If these files are incorrect, please update the |
ansible-community/antsibull#277 should fix the breakage to the docs build. However, I noted in this comment: ansible-community/antsibull#277 (comment) that the new field doesn't follow the conventions of similar fields ( |
It is not only in devel, it should be present in 2.11, also The user visible information was always supposed to be there, but we missed adding the PR that did so (here it is now #74847). As with I always meant on writing a full spec. which is mostly what is holding up #71734, had several conversations with felix on that. But the feature is also not complete yet and will still take some time to finish defining. Previously docs build was not validating these fields, if I had known I would have warned and worked with docs team about adding this one once it was used. Also this field will make it's way into the configuration (base.yml) as a way to document which settings can be overridden from the CLI, so it should not be restricted there either. |
The devel docs are broken again since now there's a new |
(That commit belongs to the above-mentioned #74847.) |
resolved_by_pr ansible-community/antsibull#307 |
Summary
Current output looks like this:
The problem is currently in
devel
and inlatest
docs (links to latest and devel). Cause of the issue appears to be here:https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/connection/ssh.py#L80
Introduced by #73708.
Issue Type
Documentation Report
Component Name
ssh connection plugin
Ansible Version
Configuration
OS / Environment
N/A
Additional Information
No other relevant information.
Code of Conduct
The text was updated successfully, but these errors were encountered: