Sphinx
Python documentation generator
Decision gist · record as of 2026-08-14
Yes. Sphinx is production-stable, actively maintained, widely adopted (top 1000 PyPI packages), and has zero known vulnerabilities. The permissive BSD-2-Clause license poses no barrier. Install friction is low. It's the standard choice for professional documentation in the Python ecosystem.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.12 or later.
- Low install friction with a pure-Python wheel distribution.
- Actively maintained with recent commits and a large repository presence (7975 stars).
License · maintenance · safety
BSD-2-Clause (permissive) — BSD-2-Clause permissive license allows use in commercial and open-source projects with minimal restrictions; attribution required.
last release 2025-12-31 (226 days) · last repo commit 2026-08-09 · 7,975 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 91,816,399 downloads/mo, #369 on PyPI
Alternatives
Verify before relying
pip install sphinx
sphinx-quickstart docs
cd docs
make html- Whether the 17 runtime dependencies introduce any transitive security concerns beyond the direct package.
- Performance characteristics when building large documentation projects with many cross-references.
What it is and what it does
Sphinx is a documentation generator that transforms reStructuredText markup into polished output in multiple formats—HTML, PDF, EPUB, LaTeX, and others. It's built on Docutils and emphasizes semantic markup, automatic cross-referencing, and code highlighting via Pygments. The tool maintains a hierarchical document structure and generates indices automatically, making it the de facto standard for Python library documentation.
Developers use Sphinx to build project documentation, API references, and technical guides. It supports multiple programming languages through extensions, offers flexible HTML templating via Jinja2, and provides an extensible plugin ecosystem for custom functionality. The package handles the full pipeline from source markup to publication-ready output.
Use it for
- Build API documentation for Python libraries with automatic function and class signatures.
- Generate multi-format technical guides (HTML, PDF, EPUB) from a single reStructuredText source.
- Create hierarchical project documentation with automatic cross-references and a searchable index.
- Publish documentation for C, C++, and JavaScript projects using language-specific extensions.
- Set up a documentation site with custom themes and branding using Jinja2 templating.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Sphinx is production-stable, actively maintained, widely adopted (top 1000 PyPI packages), and has zero known vulnerabilities. The permissive BSD-2-Clause license poses no barrier. Install friction is low. It's the standard choice for professional documentation in the Python ecosystem.
Install
sphinx on PyPI
Before you install
Low install friction with a pure-Python wheel distribution. Actively maintained with recent commits and a large repository presence (7975 stars). Supports current Python versions (3.12–3.15) and PyPy.
Requires Python 3.12 or later.
License in practice
BSD-2-Clause permissive license allows use in commercial and open-source projects with minimal restrictions; attribution required.
Quickstart
pip install sphinx
sphinx-quickstart docs
cd docs
make htmlVerify before relying
- Whether the 17 runtime dependencies introduce any transitive security concerns beyond the direct package.
- Performance characteristics when building large documentation projects with many cross-references.
Package facts
| License | BSD-2-Clause permissive |
| Python support | Supports the current Python release >=3.12 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 17 packagessphinxcontrib-applehelpsphinxcontrib-devhelpsphinxcontrib-htmlhelpsphinxcontrib-jsmathsphinxcontrib-qthelpsphinxcontrib-serializinghtmlJinja2Pygmentsdocutilssnowballstemmerbabelalabasterimagesizerequestsroman-numeralspackagingcolorama |
| Maintenance | Actively maintained 226 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 91,816,399 / month, #369 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 :: ConsoleEnvironment :: Web EnvironmentFramework :: SphinxFramework :: Sphinx :: DomainFramework :: Sphinx :: ExtensionFramework :: Sphinx :: ThemeIntended Audience :: DevelopersIntended Audience :: EducationIntended Audience :: End Users/DesktopIntended Audience :: Information TechnologyIntended Audience :: Other AudienceIntended Audience :: Science/ResearchIntended Audience :: System AdministratorsOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.15Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: DocumentationTopic :: Documentation :: SphinxTopic :: EducationTopic :: Internet :: WWW/HTTP :: Site ManagementTopic :: Internet :: WWW/HTTP :: Site Management :: Link CheckingTopic :: PrintingTopic :: Software DevelopmentTopic :: Software Development :: DocumentationTopic :: Text Editors :: DocumentationTopic :: Text ProcessingTopic :: Text Processing :: GeneralTopic :: Text Processing :: IndexingTopic :: Text Processing :: MarkupTopic :: Text Processing :: Markup :: HTMLTopic :: Text Processing :: Markup :: LaTeXTopic :: Text Processing :: Markup :: MarkdownTopic :: Text Processing :: Markup :: XMLTopic :: Text Processing :: Markup :: reStructuredTextTopic :: UtilitiesTyping :: Typed |
Evidence: sphinx-9.1.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 › “technical documentation generator”
- SphinxSphinx generates professional documentation from reStructuredText…
- sphinxcontrib-bibtexA Sphinx extension that enables BibTeX-style citations in…
- mkdocsMkDocs generates static HTML documentation sites from Markdown source…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also pelican · quartodoc · sphinx-sitemap · sphinxcontrib-htmlhelp · rst2pdf · pydoctor · sphinx-codeautolink · sphinx-simplepdf · PyLaTeX · esbonio