sphinx-docs

Solid

Sphinx documentation system expertise for technical and API documentation. Configure projects, autodoc for Python APIs, intersphinx for cross-project linking, extensions, and multiple output formats.

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 98/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Sphinx Documentation Skill Sphinx documentation system expertise for technical and API documentation. ## Capabilities - Configure conf.py for various projects - Write and manage reStructuredText (RST) content - Configure autodoc for Python API documentation - Set up intersphinx for cross-project linking - Create and manage Sphinx extensions - Generate multiple output formats (HTML, PDF, ePub) - Theme configuration (Read the Docs, Furo) - LaTeX and PDF customization ## Usage Invoke this skill when you need to: - Set up Sphinx documentation for Python projects - Generate API documentation from docstrings - Configure cross-project references - Create custom extensions - Generate PDF documentation ## Inputs | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | action | string | Yes | init, configure, autodoc, build | | projectPath | string | Yes | Path to Sphinx project | | outputFormat | string | No | html, pdf, epub (default: html) | | theme | string | No | sphinx_rtd_theme, furo, alabaster | | extensions | array | No | Sphinx extensions to enable | ### Input Example ```json { "action": "configure", "projectPath": "./docs", "theme": "furo", "extensions": ["autodoc", "napoleon", "intersphinx"] } ``` ## Project Configuration ### conf.py ```python # Configuration file for the Sphinx documentation builder. import os import sys # Add project root to path for autodoc sys.path.insert(0, os.path.abspath('..')) # -- Projec...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Related Skills