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

Adjacent filter documentation files not shown #3448

Open
numo68 opened this issue Dec 28, 2024 · 0 comments
Open

Adjacent filter documentation files not shown #3448

numo68 opened this issue Dec 28, 2024 · 0 comments

Comments

@numo68
Copy link

numo68 commented Dec 28, 2024

Bug Report

SUMMARY

I am experimenting with publishing my first collection on Ansible Galaxy. The collection contains three filters: numo68.general.json_patch, json_patch_recipe and json_diff. All three filters are implemented in the plugins/filter/json_patch.py and documented in the adjacent json_patch.yml, json_patch_recipe.ymland json_diff.yml. The ansible-doc is able to parse all three files just fine and ansible-test sanity is happy with the collection.

Uploading to Galaxy works without an error, I am however only seeing the json_patch documentation at https://galaxy.ansible.com/ui/repo/published/numo68/general/docs/ .

The tarball does contain all the files, as are they present in FILES.json.

I am a beginner in this area and it is well probable that I have missed some crucial part when documenting the collection; I was however not able to find any more information except that the filters are in fact meant to be documented in the adjacent YML files.

Note: the repo link is not live yet, that will happen soon.

Thanks

STEPS TO REPRODUCE

Inspect https://galaxy.ansible.com/ui/repo/published/numo68/general/

EXPECTED RESULTS

Seeing all three filters documented.

ACTUAL RESULTS

Seeing only the json_patch.
image

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

No branches or pull requests

1 participant