manual-write

Generate structured Sphinx manuals from code, CHM, and MD sources.

Updated Mar 17, 2026

Search Tags:#documentation #markdown #sphinx #multilingual #autodoc #doxygen-migration

Ready to run

npx skills add https://github.com/pjy4617/pjy-claude-skill --skill manual-write

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: manual-write
Source: https://github.com/pjy4617/pjy-claude-skill/tree/main/plugins/manual/skills/manual-write
Command: npx skills add https://github.com/pjy4617/pjy-claude-skill --skill manual-write

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzes program sources (code, CHM/HTML, MD) to automatically generate structured, multi-language Sphinx manuals.

Core Features & Use Cases

Generates Sphinx documentation from mixed inputs with MyST Markdown support.
Integrates API references via autodoc and organizes content with a scalable toctree.
Improves maintenance by centralizing sources and enabling multi-language outputs.

Quick Start

Provide the path to your project and the skill will analyze sources and generate a ready-to-build Sphinx manual.

Frequently Asked Questions about manual-write

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

FAQPage Schema

How do I generate Sphinx documentation from existing source code?▼

To generate Sphinx documentation from source code, provide your project path so the tool can analyze code, CHM, and MD sources to produce structured, maintainable Sphinx manuals with autodoc API references.

Can I migrate Doxygen CHM files to Sphinx manuals?▼

Yes, you can migrate Doxygen CHM content to Sphinx manuals. The tool analyzes legacy CHM and HTML files to generate structured, multi-language Sphinx documentation, enabling smoother Doxygen migration workflows.

Does Sphinx support multilingual output when generating manuals from code?▼

Sphinx multilingual output is supported when generating manuals from code. The tool configures frontmatter-driven settings to produce multi-language documentation from mixed code, CHM, and MD inputs.

How do I integrate MyST Markdown into a Sphinx autodoc project?▼

You can integrate MyST Markdown into a Sphinx autodoc project by using this tool to parse MD-based docs and source code, generating a unified manual with scalable toctree organization and API references.

What is the best way to structure a scalable Sphinx toctree for software and hardware projects?▼

The best way to structure a scalable Sphinx toctree is by centralizing source code, CHM, and MD inputs for automated analysis, which organizes content into a maintainable manual hierarchy for software and hardware projects.

How do I add optional assets and scripts to an extensible Sphinx documentation pipeline?▼

To add optional assets and scripts to an extensible Sphinx documentation pipeline, configure frontmatter settings during generation to include references and resources alongside your source code and MD inputs.