# sphinx-doc/sphinx

The Sphinx documentation generator

Repository: https://github.com/sphinx-doc/sphinx
Canonical: https://ross.abutalabs.com/products/sphinx
Homepage: https://www.sphinx-doc.org/
Language: Python
License: NOASSERTION
License Family: other
Topics: python, documentation, documentation-tool, sphinx, markdown, restructuredtext, docs
Last push: 2026-08-23T22:51:57+00:00

## Health v2 (maintenance only)
Score: 87/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 63, longevity 100
- inputs: {"age_days": 4261, "days_push": 10, "days_rel": 245, "gap_med": 1, "n_releases_24m": 14}
- flags: no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 7990, forks 2538 (observed 2026-08-28T04:10:10.602575+00:00)

## What it is
Sphinx is a Python-based documentation generator that converts reStructuredText and Markdown sources into HTML, PDF, EPUB, man pages, and other formats. It offers powerful cross-referencing, automatic API documentation from docstrings, theming, and a rich extension ecosystem.

## Use cases
- generate html documentation for a python library
- build api docs from docstrings automatically
- convert restructuredtext or markdown to pdf and epub
- create a project documentation site with search and cross-references
- host versioned docs on read the docs
- write multilingual documentation with translations

## When to choose
- documenting python, c, c++, or javascript projects with structured narrative and api docs
- you need cross-references, indices, and multiple output formats from one source
- you want a mature tool with a large extension and theme ecosystem

## When to avoid
- you want a minimal single-page readme site where a static site generator is simpler
- your team strongly prefers writing docs in plain markdown without restructuredtext directives
- you need a general-purpose website or blog with dynamic content

## Facets
- artifact type: application
- maturity: stable
- function: documentation, static-site-generator, templating, markdown, pdf, internationalization
- domain: documentation, developer-tools, web-development
- platform: python, cli, cross-platform
- tags: restructuredtext, docs-as-code, autodoc, api-documentation, html-themes, myst-markdown

## Member repositories
- sphinx-doc/sphinx (main) score 87

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:10.602575+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:32:33.856091+00:00, confidence not recorded.
  - readme: https://github.com/sphinx-doc/sphinx (fetched 2026-08-28T04:10:10.602575+00:00, sha b30425a9c740)
  - homepage: https://www.sphinx-doc.org/ (fetched 2026-08-29T08:29:38.677206+00:00, sha 37eaca67ef02)
  - site_page: https://www.sphinx-doc.org/en/master/usage/installation.html (fetched 2026-08-29T08:29:38.686481+00:00, sha 7ba249de5900)
  - site_page: https://www.sphinx-doc.org/en/master/usage/quickstart.html (fetched 2026-08-29T08:29:38.689002+00:00, sha 0eaa8bcec1df)
  - site_page: https://www.sphinx-doc.org/en/master/tutorial/getting-started.html (fetched 2026-08-29T08:29:38.700848+00:00, sha ffd97748b3c3)
  - site_page: https://www.sphinx-doc.org/en/master/tutorial/narrative-documentation.html (fetched 2026-08-29T08:29:38.702419+00:00, sha 4f7cfec260ca)
  - registry_pypi: https://pypi.org/pypi/sphinx/json (fetched 2026-08-29T08:29:38.703899+00:00, sha ac0776944fa5)
  - site_page: https://www.sphinx-doc.org/en/master/faq.html (fetched 2026-08-29T08:29:38.691583+00:00, sha 6c54bc8008a6)
  - site_page: https://www.sphinx-doc.org/en/master/changes/index.html (fetched 2026-08-29T08:29:38.693888+00:00, sha 15c4f33f891e)
  - site_page: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html (fetched 2026-08-29T08:29:38.695828+00:00, sha 1414e630fcdf)
- Data as of 2026-08-30T08:39:29.467469+00:00.