sphinx-click
Sphinx extension that automatically documents click applications
Decision gist · record as of 2026-08-14
Yes, if you maintain a Click-based CLI and use Sphinx for documentation. The extension solves a real problem—keeping CLI docs synchronized with code—and has no security vulnerabilities. The aging maintenance status (253 days since last release) is a minor concern but not a blocker, since the package is stable, has low dependencies, and the repository remains active. Install it if you want to automate CLI documentation; skip it if you don't use Click or Sphinx.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Both your Click application and any of its dependencies must be installed and importable for sphinx-click to extract documentation from it.
- Low install friction; depends only on sphinx, click, and docutils.
- Maintenance shows aging status with last commit in December 2025 and no releases in the past 253 days, but the repository remains active and not archived.
License · maintenance · safety
MIT License (permissive) — MIT License (permissive) places no restrictions on use, modification, or distribution in commercial or private projects.
last release 2025-12-04 (253 days) · last repo commit 2025-12-04 · 222 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 779,718 downloads/mo, #5,083 on PyPI
Alternatives
Verify before relying
pip install sphinx-click
In conf.py:
extensions = ['sphinx_click']
In your .rst file:
.. click:: myapp:cli
:prog: myapp- Whether the 253-day gap since last release indicates active maintenance or dormancy relative to typical Sphinx extension update cycles.
- Compatibility with recent Sphinx and Click versions beyond the stated Python >=3.10 requirement.
What it is and what it does
Sphinx-click is a Sphinx extension that bridges Click CLI applications and Sphinx documentation by automatically extracting command definitions, options, and help text from a Click parser and rendering them as formatted HTML documentation with proper links and styling.
You enable it in your Sphinx conf.py, then use a simple directive to point to your Click application's parser. The extension introspects the Click command structure and generates formatted documentation that matches your Sphinx theme. This is most useful when you want to keep your CLI help text as the single source of truth and automatically include it in your project's documentation without manual duplication.
Use it for
- Document a Click-based CLI tool by automatically rendering its command structure, options, and help text into your Sphinx docs.
- Keep CLI documentation in sync with your application code by extracting it directly from Click decorators at build time.
- Generate nested command documentation with proper HTML links and styling for complex multi-level CLI applications.
- Include CLI reference pages in your project documentation without manually rewriting command definitions.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain a Click-based CLI and use Sphinx for documentation.
The extension solves a real problem—keeping CLI docs synchronized with code—and has no security vulnerabilities. The aging maintenance status (253 days since last release) is a minor concern but not a blocker, since the package is stable, has low dependencies, and the repository remains active. Install it if you want to automate CLI documentation; skip it if you don't use Click or Sphinx.
Install
sphinx-click on PyPI
Before you install
Low install friction; depends only on sphinx, click, and docutils. Maintenance shows aging status with last commit in December 2025 and no releases in the past 253 days, but the repository remains active and not archived.
Both your Click application and any of its dependencies must be installed and importable for sphinx-click to extract documentation from it.
License in practice
MIT License (permissive) places no restrictions on use, modification, or distribution in commercial or private projects.
Quickstart
pip install sphinx-click
In conf.py:
extensions = ['sphinx_click']
In your .rst file:
.. click:: myapp:cli
:prog: myappVerify before relying
- Whether the 253-day gap since last release indicates active maintenance or dormancy relative to typical Sphinx extension update cycles.
- Compatibility with recent Sphinx and Click versions beyond the stated Python >=3.10 requirement.
Package facts
| License | MIT License permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagessphinxclickdocutils |
| Maintenance | Aging 253 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 779,718 / month, #5,083 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersIntended Audience :: Information TechnologyLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyTopic :: DocumentationTopic :: Documentation :: SphinxTopic :: Utilities |
Evidence: sphinx_click-6.2.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx click cli documentation”
- sphinx-clickSphinx-click is a Sphinx extension that automatically extracts and…
- Pallets-Sphinx-ThemesProvides Sphinx themes styled for Pallets project documentation…
- sphinxcontrib-typerA Sphinx extension that auto-generates documentation for Typer CLI…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also readthedocs-sphinx-search · sphinx-data-viewer · sphinx-gallery · sphinxcontrib-typer · click-extra · sphinx-last-updated-by-git · autodocsumm · sphinx-codeautolink · sphinx-hoverxref · sphinx-automodapi