skills.rest
hnabyz-bot
hnabyz-botCOMMUNITY
Explore all skills by this author →
GitHub

moai-docs-generation

Generate API references and user manuals from source code using Sphinx, MkDocs, TypeDoc, or Docusaurus.

Updated Jan 23, 2026
Search Tags:#documentation#MkDocs#TypeDoc#api-docs#Sphinx#static-sites
One-click install
npx skills add https://github.com/hnabyz-bot/gate_drv --skill moai-docs-generation-hnabyz-bot
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: moai-docs-generation
Source: https://github.com/hnabyz-bot/gate_drv/tree/main/.claude/skills/moai-docs-generation
Command: npx skills add https://github.com/hnabyz-bot/gate_drv --skill moai-docs-generation-hnabyz-bot

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation for software projects is often scattered across code, documentation directories, and multiple formats, leading to outdated information and inconsistent user guides.

Core Features & Use Cases

  • API documentation generation from docstrings and type hints using Sphinx, MkDocs, TypeDoc, or mkdocstrings.
  • Developer guides and user manuals produced as static sites (Nextra, Docusaurus) or PDF exports.
  • CI/CD integration to keep docs in sync with code changes and publish on hosting platforms.

Quick Start

Generate a documentation suite for a Python project by enabling Sphinx or MkDocs, and publish the HTML output.

Frequently Asked Questions about moai-docs-generation

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

FAQPage Schema
How do I generate API documentation from Python docstrings and type hints?▼

Generate API documentation from Python docstrings by configuring Sphinx or MkDocs with mkdocstrings to extract type information and render publication-ready HTML or PDF outputs.

What is the best way to keep documentation in sync with code changes in CI/CD?▼

Keep documentation in sync with code changes by integrating docs generation into CI/CD workflows, which automatically extracts updated docstrings and publishes static sites.

Can I use MkDocs and Docusaurus to build developer guides and user manuals?▼

Use MkDocs or Docusaurus to produce developer guides and user manuals as static sites, while also exporting API references and user manuals to PDF formats.

Does this documentation generation approach work with JavaScript and TypeScript projects?▼

This approach works with JavaScript and TypeScript projects by using TypeDoc to extract type information and generate comprehensive API documentation.

How do I configure documentation generation using frontmatter-driven SKILL.md?▼

Configure documentation generation by defining tool settings like Sphinx or MkDocs in frontmatter-driven SKILL.md files, which standardize the extraction of docstrings and rendering of outputs.

Related Skills

Explore More Software Engineering Skills→
spideynolovespideynolove
2

api-documentation-generator

Generate OpenAPI specs and endpoint documentation from source code.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
yasushiasahiyasushiasahi

Quality Tools

Execute standardized linting workflows for multiple languages and tools, including ESLint-based TypeScript checks with configurable severity thresholds and remediation options.

Community
Intermediate
mescamesca

documentation

Generate Python project documentation with MkDocs and mkdocstrings.

Community
Advanced