sphinx-doc

sphinx: Build Structured Documentation Sites

Sphinx turns reStructuredText content into linked documentation in formats such as HTML, PDF, EPUB, and plain text. It suits teams that need structured, cross-referenced documentation and can be extended for different languages and workflows.

View on GitHub Compare
Stars
8.1k
Forks
2.6k
Stars, last 30 days
+36
Last commit
25 days ago
Contributors
100+

Our take

Maintaineda few commits in the last 90 days

Health score

50/100

How it is scored
Activity
40
Community
82
Issues
51
Pull requests
26

+36 stars in the last 30 days

  • More contributors than 78% of the projects we track
  • Slower to merge pull requests than 98% of the projects we track

Sphinx is a well-established choice for structured, extensible documentation, with recent maintenance activity and a broad contributor base, though its release recency and Python requirement merit checking against your workflow.

Good fit if

  • You need structured documentation with automatic cross-references, indexes, or multiple output formats.
  • Your team is comfortable maintaining reStructuredText and Python-based tooling.
  • You want an extension-based workflow, including options for API documentation or notebook content.

Look elsewhere if

  • You need a recent release as a prerequisite, since no release is recorded in the past year.
  • Your documentation workflow cannot use Python 3.12 or later.
  • You need a tool centered on a different authoring format or a simpler, unstructured publishing workflow.
All health signals
Last commit2026-09-18 (25 days ago)
Commits, last 90 days4
Contributors100+ (top contributor: 44% of commits)
Issues closed, last 90 days25+ (typically closed in 103 days)
Pull requests merged, last 90 days4 (typically merged in 26 days)
Project age11 years

Checked on 2026-10-14 with the GitHub API.

Project history

Daily GitHub snapshots since Oct 7, 2026. History covers stars and forks; health signals are not tracked historically.

Selected snapshot

Stars

8,101

Forks

2,638

Change since Nov 17, 2026: +1 stars·+1 forks

Overview

Sphinx is a documentation generator for turning a collection of structured source documents into a navigable, cross-referenced publication. It addresses the challenge of maintaining documentation that grows beyond a set of standalone pages, with support for document hierarchies, generated indexes, and links between documented objects.

It is built around reStructuredText and Docutils, with extensions for additional languages and workflows. Choose it when you want control over how documentation is organized and rendered, rather than just a place to write and publish pages.

Key Features

  • Builds HTML, PDF, EPUB, plain text, TeX, manual pages, and other output formats.
  • Creates cross-references for documented functions, classes, glossary terms, and other objects.
  • Organizes documents into a hierarchy with links between siblings, parents, and children.
  • Generates general and module indexes.
  • Highlights code using Pygments.
  • Uses Jinja templates to customize HTML output.
  • Supports extensions for tasks such as automatic API documentation and Jupyter notebook integration.

Use Cases

  • A software team can build a searchable, linked manual from source files alongside a codebase.
  • A library maintainer can generate API documentation and cross-reference classes and functions.
  • A technical writing team can publish the same structured material in multiple output formats.
  • A project with documentation in multiple programming languages can use extensions to include language-specific content and API references.

What you need

Detected in the repository

  • Node.js (from package.json)
  • Python >=3.12 (from pyproject.toml)
  • A test suite and automated checks on GitHub Actions

Getting Started

Install Sphinx with pip:

pip install -U sphinx

See the README and official documentation for setup and configuration details.

License in Plain Words

No standard license was detected. Without a license, the default copyright rules apply: you may read the code, but not reuse it. Check the repository or ask the authors.

Alternatives

  • mkdocs: MkDocs builds documentation sites from Markdown and YAML configuration, while Sphinx uses reStructuredText and supports multiple output formats.
  • fern: Fern focuses on generating API documentation and SDKs from API definitions, while Sphinx builds general-purpose documentation from source content.
  • hugo: Hugo is a general-purpose Go static site generator that can host documentation, while Sphinx is built specifically for structured, cross-referenced docs.
ProjectLanguageLicenseStarsStatus
sphinxPython–8.1kMaintained
mkdocsPythonBSD-2-Clause22.5kInactive
fernTypeScriptApache-2.03.8kActive
HugoGoApache-2.090.2kActive

Considerations

The project is marked maintained and has recent commits, but activity has been modest in the measured period. No release is recorded in the past year. More than 100 contributors are represented, and contribution is not flagged as concentrated around one person. Issue closure activity is present, though the median time to close is over three months, so teams relying on upstream responses should plan for possible delays.

The stated Python requirement is 3.12 or later, and the repository also includes a Node.js runtime requirement in its package configuration. Check which tooling your chosen build workflow needs. Repository metadata reports no asserted license, while the README displays a BSD 2-Clause license badge; verify the applicable license terms in the repository before adopting or redistributing the software.

Found this useful?

Share it with someone who would like sphinx.

Comparisons