skills.rest
CJ-1981
CJ-1981COMMUNITY
Explore all skills by this author →
GitHub

moai-docs-generation

Generate API and code documentation from Python and TypeScript source code.

Updated Feb 2, 2026
Search Tags:#documentation#sphinx#api-docs#mkdocs#typedoc#static-sites
One-click install
npx skills add https://github.com/CJ-1981/excel-processor --skill moai-docs-generation-cj-1981
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: moai-docs-generation
Source: https://github.com/CJ-1981/excel-processor/tree/main/.claude/skills/moai-docs-generation
Command: npx skills add https://github.com/CJ-1981/excel-processor --skill moai-docs-generation-cj-1981

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of professional documentation from source code, technical specifications, and API definitions, reducing manual effort and ensuring consistency.

Core Features & Use Cases

  • API Documentation: Generate OpenAPI/Swagger docs from FastAPI/Express code, or from SPEC files.
  • Code Documentation: Create API references from Python (Sphinx, MkDocs) and TypeScript (TypeDoc) docstrings.
  • Static Site Generation: Build documentation websites using Nextra, Docusaurus, or VitePress.
  • Use Case: Automatically generate and deploy an up-to-date API documentation website whenever new endpoints are added to your backend service.

Quick Start

Use the moai-docs-generation skill to generate Sphinx documentation for your Python project's source code.

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 FastAPI or Express source code?▼

Generating API documentation from FastAPI or Express code is automated by this Skill, which extracts OpenAPI and Swagger definitions directly from your backend service endpoints. It processes source code to produce up-to-date API references without manual effort.

What is the best way to build a static documentation site from Python docstrings?▼

The best way to build a static documentation site from Python docstrings is using Sphinx or MkDocs configurations. This Skill automates the creation of professional code references, transforming standard docstrings into a structured, navigable documentation website.

Can I use TypeDoc to generate TypeScript API references automatically?▼

Yes, you can use TypeDoc to generate TypeScript API references automatically. This Skill integrates TypeDoc to parse TypeScript code and docstrings, creating comprehensive API documentation for your TypeScript projects.

Does this documentation generation workflow support Nextra and Docusaurus?▼

Yes, this documentation generation workflow supports Nextra, Docusaurus, and VitePress for static site generation. It facilitates building and deploying documentation websites by integrating these frameworks with your generated API docs and user guides.

Do I need to install specific tools to automate Sphinx and MkDocs workflows?▼

Yes, you need to install specific tools and configurations to automate Sphinx, MkDocs, and TypeDoc workflows. This Skill requires proper environment setup for Python, TypeScript, and static site generators to successfully build documentation sites.

Related Skills

Explore More Software Engineering Skills→
rodmena-limitedrodmena-limited
3

moai-docs-generation

Generate documentation from source code and API annotations using Sphinx, MkDocs, TypeDoc, and Nextra.

Official
Advanced
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
EstomEstom

code-documenter

Generate framework-aware documentation with docstrings, OpenAPI specs, and doc sites.

Community
Advanced
mvallimmvallim
7

generate-markdown-docs

Generate Markdown documentation from codebases with customizable headings and dependencies.

Community
Intermediate