build-docs

Generate reference documentation from code and build Sphinx HTML outputs.

Updated Jan 25, 2026

Search Tags:#automation #testing #documentation #build #release #sphinx

Ready to run

npx skills add https://github.com/benzwick/SlicerMouseMaster --skill build-docs-benzwick

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: build-docs
Source: https://github.com/benzwick/SlicerMouseMaster/tree/main/.claude/skills/build-docs
Command: npx skills add https://github.com/benzwick/SlicerMouseMaster --skill build-docs-benzwick

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate reference documentation from code, build Sphinx docs, and review screenshots to ensure up-to-date, publish-ready outputs.

Core Features & Use Cases

Automated docs generation: Generate and compile documentation from codebases into reference materials.
Sphinx build orchestration: Provide full or partial Sphinx builds for HTML outputs.
Screenshot and review workflow: Capture and validate tutorial screenshots and assets for releases.

Quick Start

Run the full documentation generation workflow to produce references, tutorials, and HTML docs.

Frequently Asked Questions about build-docs

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

FAQPage Schema

How do I automate Sphinx documentation generation from code?▼

Automate Sphinx documentation by generating reference materials directly from the codebase and compiling them into HTML outputs. This pipeline orchestrates full or partial builds to ensure publish-ready docs.

What's the best way to set up a repeatable docs build pipeline for release readiness?▼

A repeatable docs build pipeline generates code references, compiles Sphinx HTML, and validates tutorial screenshots. This ensures all documentation outputs are up-to-date and ready for software release.

Do I need Python to build Sphinx docs and generate references?▼

Yes, Python is required along with project dependencies to run the documentation generation workflow. Optional Slicer integration enables full generation capabilities for complete reference outputs.

Can I capture and validate tutorial screenshots as part of an automated docs workflow?▼

Yes, the screenshot review workflow captures and validates tutorial screenshots and assets during the build. This ensures visual documentation remains accurate and synchronized for release readiness.

Does this approach support partial Sphinx builds for HTML outputs?▼

Yes, Sphinx build orchestration supports both full and partial builds for HTML outputs. This allows targeted compilation of documentation sources without rebuilding the entire project.

When should I not use an automated reference documentation pipeline?▼

Avoid automated reference generation when a project lacks Sphinx-compatible environments or stable codebases to extract from. Without Python dependencies or accessible docs sources, the build cannot execute reliably.