skills.rest
mk-knight23
mk-knight23COMMUNITY
Explore all skills by this author →
Website𝕏@mk_knight_23GitHub

doc-generator

Generate MkDocs or Sphinx documentation and docstrings from Python source code.

1|Updated Mar 4, 2026
Search Tags:#documentation#python#docstrings#sphinx#generate#ast#mkdocs
One-click install
npx skills add https://github.com/mk-knight23/AI-Agent-Nanobot --skill doc-generator-mk-knight23
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/mk-knight23/AI-Agent-Nanobot/tree/main/skills/doc-generator
Command: npx skills add https://github.com/mk-knight23/AI-Agent-Nanobot --skill doc-generator-mk-knight23

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Python projects often lack consistent, up-to-date documentation, making it hard for developers to understand interfaces, usage, and maintenance requirements. This Skill automates the generation of thorough documentation by analyzing Python source code, extracting modules, classes, and functions, and producing ready-to-publish docs and docstrings.

Core Features & Use Cases

  • AST-based analysis: parses Python modules to identify structure, types, and docstring gaps.
  • Docstring generation: AI-assisted creation of missing or improved docstrings.
  • Documentation output: generates MkDocs or Sphinx-compatible docs and an overview report (DOCS_REPORT.md).
  • Use Case: onboard a new Python project quickly by producing a complete docs suite and documented API surface.

Quick Start

Run the doc-generator on your Python project root to produce MkDocs or Sphinx documentation.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I generate Python docstrings for an existing project automatically?▼

Automating Python docstring generation involves parsing the AST to identify modules, classes, and functions with missing documentation, then applying AI to create ready-to-publish docstrings for the codebase.

What is the best way to create MkDocs or Sphinx documentation from Python source code?▼

Creating MkDocs or Sphinx documentation from Python source code is done by analyzing the AST to extract structure and types, generating missing docstrings, and outputting a navigation structure compatible with these formats.

Can I analyze a large Python codebase to find missing docstrings?▼

Yes, you can analyze Python codebases of varying sizes and structures by parsing the AST to identify docstring gaps across modules, classes, and functions, producing a DOCS_REPORT.md with coverage details.

Does the documentation generator work with both MkDocs and Sphinx?▼

Yes, the documentation generator supports both MkDocs and Sphinx formats, outputting a complete documentation suite and navigation structure from the analyzed Python source code.

How do I onboard a new Python project quickly with proper API documentation?▼

Onboarding a Python project quickly requires generating a complete docs suite by analyzing the code structure via AST, producing documented API surfaces, and outputting a coverage overview report.

What is included in the DOCS_REPORT.md generated for Python projects?▼

The DOCS_REPORT.md includes documentation coverage details for the Python project, summarizing the analyzed modules, classes, and functions alongside the generated navigation structure.

Related Skills

Explore More Software Engineering Skills→
basher83basher83
5

doc-generator

Generate Markdown documentation from Python codebases via AST analysis.

Community
Basic
zircotezircote
5

adr-integration

Integrate ADRs into CI/CD pipelines and documentation workflows.

Community
Advanced
Friend09Friend09

python-code-quality

Analyze Python code with AST-based checks for docstrings, type hints, naming, and anti-patterns.

Community
Intermediate
EstomEstom

code-documenter

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

Community
Advanced