Sphinx Documentation Expert
Automates the creation, configuration, and management of Sphinx-based technical and API documentation.
This skill empowers Claude to act as a professional technical writer and documentation engineer specializing in the Sphinx ecosystem. It streamlines the entire documentation lifecycle, from initial project scaffolding and conf.py setup to advanced API reference generation using autodoc and Napoleon. It handles complex tasks like cross-project linking with intersphinx, multi-format builds (HTML, PDF, ePub), and theme customization for modern layouts like Furo and Read the Docs, ensuring your documentation is both comprehensive and visually professional.
Key Features
01Automated Python API documentation via autodoc and Napoleon (Google/NumPy styles)
02Multi-format output support including HTML, PDF (via LaTeX), and ePub
03Cross-project referencing and external linking using Intersphinx
04Advanced theme configuration for Furo, Read the Docs, and Alabaster
05Full support for both reStructuredText (RST) and Markdown via MyST-Parser
061,328 GitHub stars
Use Cases
01Generating professional API references directly from Python project docstrings
02Converting technical specifications into structured, versioned manuals for PDF and Web
03Setting up and theme-styling searchable documentation sites for software projects