moai-docs-generation

Name: moai-docs-generation
Availability: InStock
Author: soo-kate-yeon

Generate API documentation from source code and OpenAPI specifications.

Updated Nov 20, 2025

Search Tags:#documentation #openapi #static site #sphinx #mkdocs #typedoc

Ready to run

npx skills add https://github.com/soo-kate-yeon/shadowoo --skill moai-docs-generation-soo-kate-yeon

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: moai-docs-generation
Source: https://github.com/soo-kate-yeon/shadowoo/tree/main/.agents/skills/moai-docs-generation
Command: npx skills add https://github.com/soo-kate-yeon/shadowoo --skill moai-docs-generation-soo-kate-yeon

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires npm:sphinx-build, npm:mkdocs, npm:typedoc, and includes scripts (resource) and references (resource) and modules (resource) components.

What problem does it solve?

This Skill automates the creation of professional documentation from various sources like code, technical specifications, and API definitions, streamlining the documentation process.

Core Features & Use Cases

Code Documentation: Generates API docs from Python (Sphinx, MkDocs) and TypeScript (TypeDoc) code.
API Docs: Creates documentation from OpenAPI/Swagger specs for FastAPI and Express.
Static Sites: Supports building documentation sites with Nextra, Docusaurus, and VitePress.
Use Case: Automatically generate and deploy an API reference documentation site for your new Python backend service, ensuring it's always up-to-date with your codebase.

Quick Start

Use the moai-docs-generation skill to generate API documentation for your Python project using Sphinx.

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 OpenAPI specs?▼

Generate API documentation from OpenAPI specs by configuring the framework to parse your Swagger definitions. This Skill automates creating reference docs from OpenAPI/Swagger specs for FastAPI and Express backends.

How do I create a static documentation site from TypeScript code?▼

Create a static documentation site from TypeScript code by using TypeDoc to extract API references. This Skill supports generating docs from TypeScript projects and building static sites with Nextra, Docusaurus, or VitePress.

What is the best way to automate Python documentation generation with Sphinx?▼

Automate Python documentation generation with Sphinx by configuring the build scripts to extract docstrings. This Skill streamlines generating API docs and user guides from Python source code using Sphinx and MkDocs.

Do I need to install specific tools to use Sphinx and MkDocs for documentation?▼

Yes, you need specific tool installations for Sphinx and MkDocs. This Skill requires configured dependencies like sphinx-build and mkdocs to automate the documentation generation process from your codebase.

Can I build a user guide and API reference from source code automatically?▼

Build a user guide and API reference from source code automatically by running the generation scripts. This Skill extracts technical specifications from Python, JavaScript, and TypeScript projects to create comprehensive documentation.

Does documentation generation work with both MkDocs and Docusaurus?▼

Documentation generation works with both MkDocs and Docusaurus. This Skill supports building static documentation sites using MkDocs, Docusaurus, Nextra, and VitePress from your code and API definitions.