fw-sphinx

Community

Automate Sphinx docs with parsing and templates

Authorxiaolai
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Sphinx-based projects often struggle with keeping docs in sync with code, requiring manual edits to conf.py, toctrees, and templates; this skill automates parsing and template generation to reduce drift.

Core Features & Use Cases

  • Conf.py parsing: extract project metadata and active extensions to drive docs build.
  • Toctree navigation: interpret and validate toctree entries to ensure consistent document structure.
  • reStructuredText/MyST support: handle both .rst and .md sources for flexible authoring.
  • Template-driven generation: provide ready-made templates for API references and guides.
  • Use cases include migrating a Python project to Sphinx or maintaining a large docs site with frequent structure changes.

Quick Start

Run the adapter on your Sphinx project to parse conf.py, resolve toctree entries, and generate navigation templates.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: fw-sphinx
Download link: https://github.com/xiaolai/docs-guardian-for-claude/archive/main.zip#fw-sphinx

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.