Skip to content

Conversation

@felixfontein
Copy link
Contributor

SUMMARY

Use ansible/ansible#72635.

This shouldn't be merged before ansible-core 2.20 is out, or maybe even only later, since it will break documentation for ansible-core verisons before 2.20:

ansible-core 2.17:

ERROR! Unable to retrieve documentation from 'community.crypto.openssl_csr_pipe' due to: dictionary update sequence element #0 has length 28; 2 is required. dictionary update sequence element #0 has length 28; 2 is required

ansible-core 2.18:

ERROR! Unable to retrieve documentation from 'community.crypto.openssl_csr_pipe'. dictionary update sequence element #0 has length 28; 2 is required

ansible-core 2.19:

[ERROR]: Unable to retrieve documentation from 'community.crypto.openssl_csr_pipe': dictionary update sequence element #0 has length 28; 2 is required

@bcoca how about changing older ansible-core branches so that extends_documentation_fragment (with a string or list value) doesn't cause a total breakdown, but is simply ignored, or (even better) causes a warning that return documentation is incomplete and requires a newer ansible-core version to render completely?

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

openssl_privatekey* modules
openssl_csr* modules

@felixfontein
Copy link
Contributor Author

I created ansible/ansible#85638 to fix the failing sanity tests in ansible-core devel.

@bcoca
Copy link

bcoca commented Aug 11, 2025

By default ansible-doc should ignore 'unknown' entries. It was originally designed to allow users to create their own internal conventions for their own internal contexts. This should be a 'passthrough' and not an error, open an issue and I'll address it, but I cannot guarantee how far it will be backported if accepted at all.

@felixfontein
Copy link
Contributor Author

I created ansible/ansible#85644.

cli-ravenbgt54 added a commit to cli-ravenbgt54/community.crypto that referenced this pull request Sep 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants