skills.rest
xiaolai
xiaolaiCOMMUNITY
Explore all skills by this author →
Website𝕏@xiaolaiGitHub

fw-sphinx

Parse Sphinx conf.py and toctree to generate documentation templates.

6|Updated Feb 28, 2026
Search Tags:#documentation#sphinx#rst#templating#myst#toctree
One-click install
npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill fw-sphinx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: fw-sphinx
Source: https://github.com/xiaolai/docs-guardian-for-claude/tree/main/skills/docs-guardian/frameworks/sphinx
Command: npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill fw-sphinx

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about fw-sphinx

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

FAQPage Schema
How do I automate Sphinx documentation generation from conf.py?▼

Automate Sphinx documentation generation by parsing conf.py fields like project, extensions, master_doc, and source_suffix to extract metadata and output a mapping with template sets for generated docs.

Can I use MyST markdown files instead of reStructuredText for Sphinx docs?▼

Yes, Sphinx docs support both .rst and .md sources using MyST. The skill parses source_suffix in conf.py to handle MyST markdown files alongside reStructuredText for flexible authoring.

How do I validate toctree navigation entries in a Sphinx project?▼

Validate toctree navigation entries by parsing the Sphinx toctree structure to interpret and ensure consistent document hierarchy across common layouts like docs/source or docs/.

What is the best way to keep Sphinx documentation templates in sync with code?▼

Keep Sphinx documentation in sync by applying template-driven generation, providing ready-made templates for API references and guides to reduce manual edits and structural drift.

Does this Sphinx automation work with standard Python project layouts?▼

Yes, this Sphinx automation works across common Python project layouts such as docs/source or docs/, parsing the existing conf.py and toctree to adapt to the project's directory structure.

How do I migrate a Python project to Sphinx using automated parsing?▼

Migrate a Python project to Sphinx by running an adapter to parse conf.py, resolve toctree entries, and generate navigation templates that establish the automated documentation structure.

Related Skills

Explore More Software Engineering Skills→
Sun-Lab-NBBSun-Lab-NBB
3

api-docs

Apply Sun Lab conventions to Sphinx documentation files and configurations.

Official
Intermediate
pjy4617pjy4617

manual-write

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

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
martimramosmartimramos
1

forge-docs

Generate MkDocs documentation structures and templates for material-theme sites.

Community
Basic