sphinx-llm

library0.4.1pypypiunverified

Sphinx extension that uses LLMs to generate documentation from code. Version 0.4.1, active development on GitHub under NVIDIA. Released periodically.

devops

pip install sphinx-llm

github ↗homepage ↗

INSTALL

IMPORT

SIG · SPHINX-LLM

sphinx-llm

devopspythonv0.4.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

LLMConfig

✓ from sphinx_llm import LLMConfig

✗ from sphinx_llm import LLMConfig

Basic Sphinx conf.py setup with sphinx-llm extension. Requires OPENAI_API_KEY environment variable.

# In conf.py, add 'sphinx_llm' to extensions list extensions = ['sphinx_llm'] # Configure LLM (e.g., OpenAI) sphinx_llm_config = { 'api_key': os.environ.get('OPENAI_API_KEY', ''), 'model': 'gpt-4', 'temperature': 0.0 } autodoc_default_options = { 'member-order': 'bysource' } # Run with: sphinx-build -b html . _build/html

Debug

Known issues

breakingVersion 0.4.0+ changed the import path: symbols are no longer under `sphinx_llm.config` but directly under `sphinx_llm`.

fix

Update imports: `from sphinx_llm import LLMConfig` instead of `from sphinx_llm.config import LLMConfig`.

affects: >=0.4.0

deprecatedThe `sphinx_llm.documenter` submodule is deprecated in favor of top-level exports.

fix

Use `from sphinx_llm import LLMDocumenter`.

affects: 0.4.x

gotchaThe extension only works with Sphinx >=4.0 and Python >=3.9. Older environments will raise import errors.

fix

Upgrade Sphinx and Python to meet requirements.

affects: all

Upgrade

Version history

0.4.1latest on PyPI · released Apr 2, 2026

Audit

Dependencies

sphinxrequiredExtension requires Sphinx build system

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/NVIDIA/sphinx-llm ↗

homepagehttps://github.com/NVIDIA/sphinx-llm ↗