moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Updated Jan 12, 2026
One-click install
npx skills add https://github.com/windysky/claude_notification_wsl2 --skill moai-docs-generation-windysky
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: moai-docs-generation
Source: https://github.com/windysky/claude_notification_wsl2/tree/main/.claude/skills/moai-docs-generation
Command: npx skills add https://github.com/windysky/claude_notification_wsl2 --skill moai-docs-generation-windysky

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generating professional, consistent documentation from codebases to save time and ensure accuracy.

Core Features & Use Cases

  • Pattern-driven doc pipelines for API docs, user guides, and knowledge bases using Sphinx, MkDocs, TypeDoc, and Nextra.
  • Automated doc updates in CI/CD workflows, syncing code changes to published docs.
  • Multi-format output templates (HTML sites, PDFs, and OpenAPI-style references) for various audiences.

Quick Start

Create a docs pattern for a Python package using Sphinx autodoc and MkDocs Material.

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 docs from code automatically?

Sphinx autodoc and MkDocs Material generate professional Python package docs by extracting docstrings and module structures into structured HTML sites. Configure pattern-driven pipelines to automate extraction and template rendering.

Can I sync documentation updates in a CI/CD workflow?

Automated doc pipelines in CI/CD workflows sync code changes to published docs by detecting repository updates and regenerating references. This ensures outputs remain accurate across deployments without manual intervention.

Does this documentation generation workflow support multiple output formats?

Multi-format output templates render generated documentation into HTML sites, PDFs, and OpenAPI-style references. These formats serve diverse audiences by publishing the same code-derived content across different distribution channels.

What is the best way to build a knowledge base from an existing codebase?

Pattern-driven documentation pipelines build knowledge bases from existing codebases by extracting technical specifications and user guides directly from source files. This approach ensures generated content stays synchronized with implementation logic.

How do I set up Sphinx and MkDocs for automated Python package documentation?

Configure Sphinx autodoc and MkDocs Material templates to extract Python module docstrings into structured documentation sites. This pipeline automates professional doc generation by parsing source code patterns and rendering template outputs.