linode / linode/ansible-specdoc
[Bug]: Modules docs don't render properly in Ansible Galaxy web
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
### Expected Behavior
The generated dostrings should be in proper format for Ansible Galaxy. The Galaxy website should parse the DOCUMENTATION etc markdown and render nice html.
Basically, it seems that with the currecnt version of Galaxy web, the format changed and ansible-specdoc-generated docs are somehow wrong.
Thanks for your work on this useful project!
### Actual Behavior
Only "Synopsis" is rendered.
https://galaxy.ansible.com/ui/repo/published/linode/cloud/content/module/instance/
### Steps to Reproduce
_No response_
### Error Output
_No response_
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the generated docstrings with the Ansible Galaxy page linked in the issue, focusing on the DOCUMENTATION sections that render only their Synopsis. Identify the format mismatch with the current Galaxy web version; done means the generated module documentation renders its sections as HTML beyond Synopsis.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100