Galaxy: docs show error for new modules in collection, sanity passes though

@gundalow on your request, here the post

I just noticed an issue on galaxy in docs for the new modues but couldn’t find the cause. Sanity tests passed.

Any help appreciated.

UPDATE:

I just noticed, some old existing modules are also affected: Ansible Galaxy

Hi @resmo, it’s a known bug (Docs formatting broken on Galaxy for all modules/plugins that use `M(...)` (and likely also `P(...)`) in markup · Issue #5586 · ansible/ansible-hub-ui · GitHub) that will hopefully go away on August 25th (according to the updated timeline in fix: use docs_blob.contents for plugin link resolution in docs tab by dbrennand · Pull Request #5589 · ansible/ansible-hub-ui · GitHub).

There’s also an existing thread on this bug: Warning alert:Documentation Syntax Error: cannot parse plugin documention.

hmm so this is a known issue since … june !? :face_with_raised_eyebrow:

I read about antsibul-docs and to generate html for module docs and am about to write a scenrario gjuide as well and publish it as static site.

Can you recommend any tools, show any examples and stuff that helps to achieve that more integrated?

Ok, I found your community.crypto/.github/workflows/docs-push.yml at main · ansible-collections/community.crypto · GitHub and docs, perfect!

Yeah, I was about to point to GitHub - ansible-community/github-docs-build: GitHub actions and workflows for building Ansible collection documentation. · GitHub. Thanks to @briantist for getting this started :slight_smile: