manual-build

Automate Sphinx documentation builds into HTML, PDF, and EPUB formats.

Updated Mar 17, 2026
One-click install
npx skills add https://github.com/pjy4617/pjy-claude-skill --skill manual-build
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: manual-build
Source: https://github.com/pjy4617/pjy-claude-skill/tree/main/plugins/manual/skills/manual-build
Command: npx skills add https://github.com/pjy4617/pjy-claude-skill --skill manual-build

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Sphinx documentation often requires manual setup and multiple command invocations to generate HTML, PDF, and EPUB outputs; this Skill automates locating the docs, installing dependencies, and coordinating multi-format builds.

Core Features & Use Cases

  • Automated discovery of Sphinx projects by locating conf.py and recognizing multilingual documentation structures.
  • Dependency management for Sphinx-based builds (sphinx, sphinx-rtd-theme, myst-parser, sphinx-copybutton) to ensure repeatable environments.
  • Multi-format build support for HTML, PDF, and EPUB with optional --clean builds and support for language-specific doc trees.
  • Use Case: In a repository with docs in several languages, run the skill to produce an HTML site and accompanying PDF/EPUB bundles for distribution.

Quick Start

Run a full HTML build of the Sphinx docs in the repository.

Frequently Asked Questions about manual-build

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

FAQPage Schema
How do I automate building Sphinx documentation into HTML, PDF, and EPUB formats?

To automate Sphinx documentation builds, use a tool that locates your conf.py directory, installs required dependencies like sphinx and myst-parser, and coordinates multi-format output generation. This eliminates manual command invocations for HTML, PDF, and EPUB builds.

What is needed to generate a PDF from Sphinx documentation?

Generating a PDF from Sphinx documentation requires a LaTeX toolchain installed in your environment. You also need Python 3.8+ and pip to manage Sphinx dependencies like sphinx-rtd-theme and myst-parser before running the build process.

Does Sphinx support building multilingual documentation structures automatically?

Sphinx supports multilingual documentation structures by discovering language-specific folders within your docs directory. An automated build tool can identify these setups and produce HTML, PDF, or EPUB outputs for each language tree without manual configuration.

How do I run a clean build for Sphinx HTML documentation?

To run a clean build for Sphinx HTML documentation, use an automation tool that supports an optional --clean flag to remove previous output directories. This ensures your generated HTML site is rebuilt from scratch without stale files.

What Python version is required to automate Sphinx multi-format builds?

Automating Sphinx multi-format builds requires Python 3.8 or higher and pip. These are necessary to install and manage dependencies including sphinx, sphinx-rtd-theme, myst-parser, and sphinx-copybutton for your documentation workflow.