Agent skill
sphinx-common-issues
Sub-skill of sphinx: Common Issues (+1).
Install this agent skill to your Project
npx add-skill https://github.com/vamseeachanta/workspace-hub/tree/main/.claude/skills/_archive/development/documentation/sphinx/common-issues
SKILL.md
Common Issues (+1)
Common Issues
Autodoc Cannot Find Module
# conf.py - Add source to path
import sys
from pathlib import Path
sys.path.insert(0, str(Path(__file__).parents[2] / 'src'))
Intersphinx Inventory Not Loading
# conf.py - Use local inventory file
intersphinx_mapping = {
'python': ('https://docs.python.org/3', 'python-objects.inv'),
}
# Download inventory manually
# curl -O https://docs.python.org/3/objects.inv
Build Warnings as Errors
# Build without -W flag for debugging
sphinx-build -b html docs/source docs/build/html
# Then fix warnings before re-enabling
sphinx-build -b html docs/source docs/build/html -W
Napoleon Not Parsing Docstrings
# conf.py - Ensure napoleon is configured
napoleon_google_docstring = True
napoleon_numpy_docstring = True
# Check docstring format - must have proper indentation
def func():
"""
Summary line.
Args:
param: Description. # Note: proper indentation
"""
PDF Build Fails
# Install full LaTeX distribution
# Ubuntu
sudo apt-get install texlive-full
# macOS
brew install --cask mactex
# Check LaTeX installation
pdflatex --version
latexmk --version
Debug Mode
# Verbose build
sphinx-build -b html docs/source docs/build/html -v
# Very verbose
sphinx-build -b html docs/source docs/build/html -vvv
# Show traceback on errors
sphinx-build -b html docs/source docs/build/html -T
# Keep going on errors
sphinx-build -b html docs/source docs/build/html --keep-going
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
gsd-complete-milestone
Archive completed milestone and prepare for next version
gsd-reapply-patches
Reapply local modifications after a GSD update
gsd-verify-work
Validate built features through conversational UAT
gsd-thread
Manage persistent context threads for cross-session work
clinical-trial-protocol
Generate clinical trial protocols for medical devices or drugs through a modular, waypoint-based architecture with research-only and full protocol modes.
single-cell-rna-qc
Performs quality control on single-cell RNA-seq data (.h5ad or .h5 files) using scverse best practices with MAD-based filtering and comprehensive visualizations.
Didn't find tool you were looking for?