Agent skill
documentation-3-automated-api-documentation
Sub-skill of documentation: 3. Automated API Documentation (+2).
Install this agent skill to your Project
npx add-skill https://github.com/vamseeachanta/workspace-hub/tree/main/.claude/skills/_archive/development/documentation/documentation/3-automated-api-documentation
SKILL.md
3. Automated API Documentation (+2)
3. Automated API Documentation
# Generate API docs from docstrings
"""
Module description.
Example:
>>> import mymodule
>>> mymodule.function()
'result'
"""
*See sub-skills for full details.*
## 4. Version Documentation
```bash
# Version docs with releases
version_docs() {
local version="$1"
# MkDocs with mike
mike deploy "$version" latest -u
mike set-default latest
# Docusaurus
npm run docusaurus docs:version "$version"
}
5. Link Validation
# Check for broken links
check_links() {
local docs_dir="${1:-docs}"
# Using markdown-link-check
find "$docs_dir" -name '*.md' -exec markdown-link-check {} \;
# Using linkchecker on built site
linkchecker ./site/index.html
}
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
gsd-complete-milestone
Archive completed milestone and prepare for next version
gsd-reapply-patches
Reapply local modifications after a GSD update
gsd-verify-work
Validate built features through conversational UAT
gsd-thread
Manage persistent context threads for cross-session work
clinical-trial-protocol
Generate clinical trial protocols for medical devices or drugs through a modular, waypoint-based architecture with research-only and full protocol modes.
single-cell-rna-qc
Performs quality control on single-cell RNA-seq data (.h5ad or .h5 files) using scverse best practices with MAD-based filtering and comprehensive visualizations.
Didn't find tool you were looking for?