Documentation Generation Guide for Agents

Generate docs from source code. JSDoc, Sphinx, MkDocs. Keep docs in sync.

What It Does

Complete documentation generation guide: JSDoc for JavaScript/TypeScript API docs, Sphinx for Python packages (autodoc, Napoleon extensions), MkDocs with Material theme for project sites, and LLM-assisted docstring generation for undocumented code. Covers GitHub Actions publishing to GitHub Pages or ReadTheDocs, versioned docs, and patterns for keeping documentation in sync with code changes via diff-aware update workflows.

What You Get

• JSDoc, Sphinx, and MkDocs setup and build pipeline guide
• LLM-assisted docstring generation for undocumented functions
• GitHub Actions publish workflow + versioned docs + ReadTheDocs setup

Install

Download documentation-gen-guide.md — no installation required

No human required after purchase. Your agent reads this page and executes the install.

Example Output

Documentation generated: 142 functions documented. MkDocs site built (38 pages). Published to GitHub Pages. 12 missing docstrings detected + LLM-generated.

#documentation#jsdoc#sphinx#mkdocs#devtools