Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

Sphinx

By Sphinx · sphinx-doc.org

  • Free plan
  • Windows
  • macOS
  • Linux
  • Web
  • API
  • Self-hosted
8.3 Club score Visit sphinx-doc.org

What Sphinx is

Sphinx is a free Python application that generates technical documentation from structured text. Authors can write in reStructuredText or MyST Markdown, though Markdown requires a separate MyST-Parser installation. Built-in builders produce HTML, LaTeX for PDF, ePub, manual pages, Texinfo, and plain text. References can connect sections, figures, tables, citations, glossaries, and code objects within one project or across projects. The autodoc extension imports modules and includes material from their docstrings. Built-in and third-party themes and extensions add options for diagrams, doctests, API documentation, and links to other documentation. Sphinx also includes GitHub Pages publishing, Graphviz graphs, intersphinx links, gettext-based translation mechanisms, and full-text search. It can be installed through PyPI, Conda, Linux package managers, Homebrew or MacPorts, Chocolatey, Docker, or from source. Deployment options include Read the Docs, GitHub Pages, GitLab Pages, Netlify, and self-hosted servers. The code is released under the two-clause BSD license, and the community-supported project welcomes contributions.

Who it suits

Sphinx suits developers and teams creating structured technical documentation, especially when they need multiple output formats or links across projects. Markdown authors need to install MyST-Parser separately.

Good to know, and what to watch

  • Builds HTML, PDF-oriented LaTeX, ePub, and other formats
  • Links references within and across projects
  • Autodoc can include module docstrings
  • Supports themes, extensions, and full-text search
  • Markdown requires a separate MyST-Parser installation
  • Web Support has limited adoption and development

Sphinx open-source software

Free

Free plan

The Club's review

Overview

Sphinx is a documentation generator for teams that want to build and maintain technical material from structured text. It suits developers and documentation authors who need reusable references, multiple output formats, or documentation connected to Python code. It is a strong fit for a configurable build workflow, but Markdown authors must add a separate parser.

Key features

Authoring and output

Authors can write in reStructuredText or MyST Markdown, then build HTML, LaTeX for PDF, ePub, manual pages, Texinfo, or plain text. That range is useful when documentation must serve a website as well as readers of print-oriented or command-line formats. MyST Markdown requires a separately installed parser, which adds a dependency to setup and maintenance.

References and API documentation

Sphinx can link sections, figures, tables, citations, glossaries, and code objects within a project or across projects. Those links help keep large documentation sets navigable as material is split among codebases. Its autodoc extension imports Python modules and incorporates their docstrings, making it a natural option when API documentation should track code maintained in Python.

Themes, extensions, and publishing

Built-in, third-party, and custom themes let teams shape the generated HTML, while extensions add capabilities such as diagrams and doctests. Built-in extensions include Graphviz graphs, GitHub Pages publishing, and intersphinx links to other projects' documentation. Read the Docs, GitLab Pages, Netlify, and self-hosted servers are also deployment options, so teams can choose a publishing destination without treating Sphinx itself as a hosted documentation service.

Full-text search is supported. Sphinx also provides gettext-based translation workflows. Its Python API can integrate documentation into web applications, though the Web Support feature has seen limited adoption and development; teams considering it for a web app should weigh that narrower path against the more established documentation-building use cases.

Installation and support

Sphinx is a Python application, installable through PyPI, Conda, Linux package managers, Homebrew or MacPorts, Chocolatey, Docker, or from source. Official Docker images cover standard use and LaTeX PDF builds. The project is community supported, with questions and problem reports directed to Stack Overflow, GitHub Discussions, GitHub Issues, or the sphinx-users mailing list. That gives users several ways to seek help, but the support model is community-based rather than a paid service.

Pricing

Sphinx is free: the Sphinx open-source software plan costs nothing under the BSD 2-Clause license. Users can install it locally or self-host it. There are no paid tiers or seat-based charges in this plan, making it suitable for individual authors and teams that can manage their own build and deployment workflow. The trade-off is that support comes from community channels, and the license includes warranty disclaimers.

Platforms

Sphinx supports Linux, macOS, and Windows, as well as API, web, and self-hosted use. Its installation choices span common package managers and containers, which gives teams flexibility in how they set up builds. The project also lists deployment through hosted documentation and static-site services or on self-hosted servers.

Who it's for

Sphinx is a good choice for technical teams that want documentation as structured text, need cross-project links, or publish the same source in several formats. Python teams can use autodoc to bring docstrings into their documentation, while teams with translation needs can use gettext catalogs. It is less compelling for groups seeking a managed, paid support arrangement, or for web applications that depend on Sphinx's less-established Web Support feature.

Pros and cons

Pros

  • Broad output choices: HTML, PDF-oriented LaTeX, ePub, manual pages, Texinfo, and plain text support more than a website-only workflow.
  • Detailed cross-referencing: Links across projects and to code objects, figures, citations, and glossaries help organize large documentation collections.
  • Python API documentation: autodoc can incorporate module docstrings, tying API material to code.
  • Extensible and free: Themes and extensions can adapt builds, and the BSD-licensed software can be installed locally or self-hosted at no charge.

Cons

  • Markdown needs an extra dependency: MyST-Parser must be installed separately, adding setup work for Markdown-based teams.
  • Community support: Help is available through community venues rather than a paid support tier.
  • Web Support is a narrower bet: Its limited adoption and development make it a less secure choice for teams seeking a mature documentation-in-web-app feature.

Alternatives

Asciidoctor is another free, open-source documentation tool, with core converters for HTML 5, DocBook 5, and man pages; choose it when those formats and its MIT license better fit your needs. Doxygen is a free and open-source option with Windows, Linux, and macOS downloads. Natural Docs is another free option, released under AGPL version 3.

Scalar may suit teams looking for a freemium API documentation service: its free plan covers up to 3 APIs, 1 SDK of up to 25 endpoints, 1 editor seat, and 50 Agent Scalar credits. Redocly is worth considering for API documentation where a paid per-seat plan is acceptable; its Pro plan is $10 a month, billed per seat/month, with one project and 100 pages.

Kotlin/JS, Swift Package Manager, and Sandcastle Help File Builder are also alternatives.

For more options, browse Documentation Generators, Developer Documentation Software, Technical Documentation Software, or Knowledge base software.

Verdict

Choose Sphinx if you want a free, self-hostable documentation build system with multiple output formats, deep cross-references, and a path to generate Python API material from docstrings. Its flexibility is the main reason to pick it; the extra parser for Markdown and community-only support are the main reasons to look elsewhere if you want a simpler setup or a paid support relationship.

The verdict

Sphinx offers a flexible documentation workflow with multiple formats, reference links, and extension options. It is free under the two-clause BSD license, but Markdown authoring requires an additional parser.

What the maker publishes

API documentation
The autodoc extension imports documented modules and includes documentation from their docstrings. source
API documentation
Automatic API documentation can be generated from docstrings for Python, C++ and other software domains. source
Authoring
Sphinx supports reStructuredText and MyST Markdown; Markdown support uses the separately installed MyST-Parser. source
Authoring
Documentation can be authored in reStructuredText or MyST Markdown. source
Cross-references
Sphinx supports references within a project and across different projects, including references to sections, figures, tables, citations, glossaries, and code objects. source
Deployment integrations
The documentation lists Read the Docs, GitHub Pages, GitLab Pages, Netlify and self-hosted servers as deployment options. source
Docker
Official Docker images include sphinxdoc/sphinx for standard use and sphinxdoc/sphinx-latexpdf for LaTeX PDF builds. source
Extensions
Sphinx provides extension mechanisms and built-in and third-party extensions for tasks such as diagrams and code testing. source
Founded
2007 source
Free plan
Yes source
Installation
Sphinx is a Python application installable through PyPI, Conda, Linux package managers, Homebrew or MacPorts, Chocolatey, Docker, or from source. source
Integrations
Built-in extensions include GitHub Pages publishing, Graphviz graphs, and intersphinx links to other projects’ documentation. source
Internationalization
Sphinx provides mechanisms for translating documents using gettext catalogs. source
Internationalization
Sphinx supports translating documentation into multiple languages. source
License
The project states that its code is released under the two-clause BSD license. source
License and warranty
Sphinx code is released under the two-clause BSD license, with warranty disclaimers in the license text. source
Output formats
Built-in builders produce formats including HTML, LaTeX for PDF, ePub, manual pages, Texinfo, and plain text. source
Output formats
Sphinx generates HTML, LaTeX for PDF, ePub, Texinfo and other documentation formats. source
Project audience
The documentation describes Sphinx as community supported and welcomes contributions from anyone. source
Purpose
Sphinx generates technical documentation from structured text. source
Support
The project directs users to Stack Overflow, GitHub Discussions, GitHub Issues, or the sphinx-users mailing list for questions and problem reports. source
Support model
Sphinx is community supported and welcomes contributions from anybody, with tutorials, forums, examples and contributor resources. source
Themes
Sphinx includes built-in and third-party HTML themes and supports custom themes. source
Themes and extensions
Sphinx supports built-in and third-party themes and extensions, including extensions for diagrams, doctests, API documentation, and links to other projects’ documentation. source

Checked against the maker's pages on 30 Sept 2026.