skills.rest
h102-log
h102-logCOMMUNITY
Explore all skills by this author →
GitHub

moai-docs-generation

Generate API references, user guides, and static documentation sites with Sphinx, MkDocs, TypeDoc, and OpenAPI.

Updated Jun 18, 2026
Search Tags:#documentation#openapi#api docs#static site#sphinx#mkdocs#typedoc
One-click install
npx skills add https://github.com/h102-log/pdfrag --skill moai-docs-generation-h102-log
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: moai-docs-generation
Source: https://github.com/h102-log/pdfrag/tree/main/.claude/skills/moai-docs-generation
Command: npx skills add https://github.com/h102-log/pdfrag --skill moai-docs-generation-h102-log

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Keeping technical documentation accurate and current is difficult when API references, user guides, and doc sites must be manually written and maintained separately from source code. This Skill provides proven patterns for generating documentation directly from code annotations and automating doc builds in CI/CD pipelines. ## Core Features & Use Cases - Code-to-Docs Generation: Produce API references from Python docstrings with Sphinx or mkdocstrings, and from TypeScript/JavaScript with TypeDoc and JSDoc. - OpenAPI Documentation: Enhance FastAPI auto-generated docs or add swagger-jsdoc annotations to Express routes, then render with Swagger UI or Redoc. - Static Doc Sites & CI/CD: Build documentation sites with Nextra, Docusaurus, VitePress, or MkDocs Material and automate deployment via GitHub Actions. - Use Case: A backend team ships a FastAPI service and needs hosted API docs; use this Skill to enrich endpoint docstrings, export the OpenAPI spec, and deploy a MkDocs Material site through a GitHub Actions workflow. ## Quick Start Generate API documentation for my Python project using MkDocs with mkdocstrings and set up a GitHub Actions workflow to deploy it to GitHub Pages.

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

Use Sphinx with the autodoc and napoleon extensions: run sphinx-apidoc against your source directory, then build with make html. Alternatively, use MkDocs with the mkdocstrings plugin and reference objects in Markdown with the ::: module.path syntax.

What is the difference between Sphinx and MkDocs for Python documentation?▼

Sphinx uses reStructuredText and offers deep autodoc integration with multiple output formats including PDF. MkDocs uses Markdown, pairs with the Material theme for modern sites, and relies on mkdocstrings for API reference generation.

How do I document a TypeScript library with TypeDoc?▼

Install typedoc as a dev dependency, create a typedoc.json with entryPoints and output directory, and write TSDoc comments using @param, @returns, and @example tags. Run typedoc to generate HTML documentation with type information and inheritance hierarchies.

Does FastAPI generate OpenAPI documentation automatically?▼

Yes, FastAPI automatically serves Swagger UI at /docs, ReDoc at /redoc, and the OpenAPI JSON at /openapi.json. You can enhance it with route docstrings, Pydantic Field descriptions, tags, and response models.

How do I automate documentation deployment in CI/CD?▼

Create a GitHub Actions workflow triggered on pushes to main that installs doc dependencies, runs the build command such as sphinx-build or mkdocs build, and deploys the output with an action like peaceiris/actions-gh-pages.

How can I measure docstring coverage in a Python project?▼

Use the interrogate package to analyze docstring coverage across your codebase. Configure a minimum coverage threshold in pyproject.toml and run it in CI so builds fail when coverage drops below the defined limit.

Related Skills

Explore More Software Engineering Skills→
shllgshllg

tsdoc

Generate TypeScript documentation from TSDoc annotations for the night-orch project.

Community
Intermediate
modu-aimodu-ai
1.2k

moai-docs-generation

Generates API references, user guides, and documentation sites using Sphinx, MkDocs, TypeDoc, and OpenAPI.

Official
Intermediate
outfitter-devoutfitter-dev
6

docs-audit

Audit markdown documentation against the current codebase state.

Official
Advanced
mei28mei28
3

doc-gen

Generate OpenAPI specs and Markdown API references from codebases.

Community
Advanced