Skip to content

Fix Galaxy parsing for deprecated commit docs - #678

Open
ting-hong-shieh wants to merge 1 commit into
PaloAltoNetworks:developfrom
ting-hong-shieh:agent/fix-ansible-doc-parsing
Open

Fix Galaxy parsing for deprecated commit docs#678
ting-hong-shieh wants to merge 1 commit into
PaloAltoNetworks:developfrom
ting-hong-shieh:agent/fix-ansible-doc-parsing

Conversation

@ting-hong-shieh

Copy link
Copy Markdown

Summary

Render the deprecated commit module names as inline code in the shared documentation fragment instead of module links.

The collection-wide Galaxy documentation error first appears after the fragment changed from short module links to fully qualified M(...) links. Galaxy's documentation renderer fails on those fully qualified links, and every module that includes the fragment is affected. Using C(...) preserves the full replacement module names without asking the renderer to resolve them as links.

Closes #673.

Validation

  • ansible-test sanity --local --test validate-modules --python 3.12
  • ansible-galaxy collection build --force
  • Processed the built collection with galaxy-importer==0.4.39

@ting-hong-shieh
ting-hong-shieh marked this pull request as ready for review August 13, 2026 15:06
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.

doc rendering bug in Ansible Galaxy "Documentation Syntax Error: cannot parse plugin documention." affecting multiple modules since v2.12.0

1 participant