skills.rest
eclipse-slm
eclipse-slmOFFICIAL
Explore all skills by this author →
GitHub

docs-generate

Generate Ansible collection module documentation and README files using collection_prep.

8|7|Updated Feb 14, 2023
Search Tags:#documentation#readme#ansible#rst#generate#tox#collection_prep
One-click install
npx skills add https://github.com/eclipse-slm/slm --skill docs-generate-eclipse-slm
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-generate
Source: https://github.com/eclipse-slm/slm/tree/main/.agents/skills/docs-generate
Command: npx skills add https://github.com/eclipse-slm/slm --skill docs-generate-eclipse-slm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires tox, collection_prep.

What problem does it solve? Keeping Ansible collection documentation in sync with module code is tedious and error-prone. This Skill automates the generation of module RST files and README updates so documentation always reflects current DOCUMENTATION strings, arguments, and return values. ## Core Features & Use Cases - Automated RST Generation: Runs tox -e add_docs to produce one RST file per module with synopsis, parameters, return values, and examples. - README Regeneration: Updates README.md with the current module list, descriptions, and compatibility information. - Stable-Branch Link Fixes: Provides commands to correct generated links that point to main instead of the release branch. - Use Case: After changing a module's arguments before a stable-11 release, run this Skill to regenerate all docs and fix branch links in one pass. ## Quick Start Regenerate the documentation for my Ansible collection and update the README with the current module list.

Frequently Asked Questions about docs-generate

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for an Ansible collection?▼

Run tox -e add_docs from the collection root, which invokes collection_prep_add_docs to generate RST files per module and update README.md. The tox.ini must contain a [testenv:add_docs] section with collection_prep as a dependency.

What tool generates Ansible module RST documentation?▼

collection_prep from the ansible-network GitHub organization generates module RST files and README updates from DOCUMENTATION strings. Install it via pip from the GitHub repository or let tox install it automatically.

Why does collection_prep fail with no modules found?▼

collection_prep fails when module files are not located under plugins/modules/ in the collection directory structure. Verify your collection follows the standard layout with Python module files in that path.

How do I fix README links pointing to the main branch for a stable release?▼

collection_prep always generates links pointing to the main branch. Run sed to replace /blob/main/docs/ with /blob/stable-11/docs/ in README.md, adjusting the branch name for your release.

What are the prerequisites for running collection_prep?▼

You need Python 3.8 or later, tox installed, a tox.ini with an add_docs testenv, and a galaxy.yml with the repository URL set. collection_prep itself is installed automatically by tox or manually via pip from GitHub.

Related Skills

Explore More Software Engineering Skills→
IntentArchitectIntentArchitect
23

module-versioning

Sets an Intent Architect module version via Module Settings and propagates it to dependents.

Official
Intermediate
MacHu-GWUMacHu-GWU

py-changelog

Update release-history.rst changelog sections from git history.

Community
Advanced
pantheon-orgpantheon-org
9

ansible-validator

Validate Ansible playbooks, roles, and collections for syntax, linting, and security.

Official
Advanced
yulonghe97yulonghe97
8

scaffold

Generate architecture diagrams, doc stubs, and a module registry from Markdown plans.

Community
Advanced