Agent skill
sphinx-5-generate-api-documentation
Sub-skill of sphinx: 5. Generate API Documentation (+1).
Install this agent skill to your Project
npx add-skill https://github.com/vamseeachanta/workspace-hub/tree/main/.claude/skills/_archive/development/documentation/sphinx/5-generate-api-documentation
SKILL.md
5. Generate API Documentation (+1)
5. Generate API Documentation
# Auto-generate API documentation stubs
sphinx-apidoc -o docs/source/api src/mypackage -f -e -M
# Options:
# -o: Output directory
# -f: Force overwrite
# -e: Separate pages for each module
# -M: Module-first ordering
# -d 2: TOC depth
# Build HTML documentation
sphinx-build -b html docs/source docs/build/html
# Build with verbose output
sphinx-build -b html docs/source docs/build/html -v
# Clean and rebuild
rm -rf docs/build && sphinx-build -b html docs/source docs/build/html
6. MyST Markdown Support
# conf.py - Enable MyST
extensions = [
'myst_parser',
]
# MyST configuration
myst_enable_extensions = [
'amsmath',
'colon_fence',
'deflist',
'dollarmath',
'fieldlist',
'html_admonition',
'html_image',
'replacements',
'smartquotes',
'strikethrough',
'substitution',
'tasklist',
]
myst_heading_anchors = 3
myst_footnote_transition = True
<!-- docs/source/guide/overview.md -->
# Overview
This guide provides an overview of MyProject.
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?