# Documentation 3 Automated API Documentation

> Sub-skill of documentation: 3. Automated API Documentation (+2).

- Skill: `vamseeachanta/documentation-3-automated-api-documentation` (Agent Skill)
- Install (CLI): `npx skillmds@latest add vamseeachanta/documentation-3-automated-api-documentation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/vamseeachanta/documentation-3-automated-api-documentation/raw
- Safety review: CAUTION (external: skill-scanner FAIL, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: vamseeachanta (https://skillmd.com/u/vamseeachanta)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/vamseeachanta/documentation-3-automated-api-documentation

---


# 3. Automated API Documentation (+2)

## 3. Automated API Documentation


```python
# 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


```bash
# 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
}
```