Sphinx

No phone app

6.2No. 80 of 138
in Knowledge base software

Recognised40% of the score21
Phone app26% of the score0
Documented20% of the score80
Free plan14% of the score100

Free plan: Yes
Runs on: api, Linux, Mac, self-hosted, Web, Windows

Summary

Sphinx generates technical documentation from structured text. It supports reStructuredText and MyST Markdown; using Markdown requires installing MyST-Parser separately. Its built-in builders can produce HTML, LaTeX for PDF, ePub, manual pages, Texinfo, and plain text. References can connect material within one project or across projects, including sections, figures, tables, citations, glossaries, and code objects. The autodoc extension imports modules and incorporates documentation from their docstrings. Built-in and third-party themes and extensions add options such as diagrams, doctests, and API documentation. Sphinx also includes integrations for GitHub Pages publishing, Graphviz graphs, and links to other projects’ documentation. It supports document translation through gettext catalogs and provides full-text search. The Python application can be installed through package managers, Docker, or from source, and deployed to services such as Read the Docs or self-hosted servers. The project is community supported, and its code is released under the two-clause BSD license. Sphinx is free.

Who it is for

Sphinx suits developers and teams creating technical documentation from structured text, especially when they need multiple output formats or cross-project references. It also supports API documentation and translation workflows.

What is good

Builds HTML, PDF, ePub, and other formats
Links references within and across projects
Autodoc can include module docstrings
Supports themes, extensions, and full-text search

What to know first

Markdown requires separately installed MyST-Parser
Web Support has had limited adoption and development

Verdict

Sphinx offers a broad documentation toolset, from multiple output formats to API references and translation support. It is free under the two-clause BSD license, with Markdown authoring requiring a separate parser.

Sphinx plans and pricing

All plans

Sphinx open-source software Free BSD 2-Clause license · install locally or self-host github.com · 30 Sept 2026

Compared on knowledge base software

Free plan: Yessphinx-doc.org

Facts

Purpose: Sphinx generates technical documentation from structured text.sphinx-doc.org · 30 Sept 2026
Authoring: Sphinx supports reStructuredText and MyST Markdown; Markdown support uses the separately installed MyST-Parser.sphinx-doc.org · 30 Sept 2026
Output formats: Built-in builders produce formats including HTML, LaTeX for PDF, ePub, manual pages, Texinfo, and plain text.sphinx-doc.org · 30 Sept 2026
Cross-references: Sphinx supports references within a project and across different projects, including references to sections, figures, tables, citations, glossaries, and code objects.sphinx-doc.org · 30 Sept 2026
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.sphinx-doc.org · 30 Sept 2026
API documentation: The autodoc extension imports documented modules and includes documentation from their docstrings.sphinx-doc.org · 30 Sept 2026
Integrations: Built-in extensions include GitHub Pages publishing, Graphviz graphs, and intersphinx links to other projects’ documentation.sphinx-doc.org · 30 Sept 2026
Internationalization: Sphinx provides mechanisms for translating documents using gettext catalogs.sphinx-doc.org · 30 Sept 2026
Installation: Sphinx is a Python application installable through PyPI, Conda, Linux package managers, Homebrew or MacPorts, Chocolatey, Docker, or from source.sphinx-doc.org · 30 Sept 2026
License: The project states that its code is released under the two-clause BSD license.sphinx-doc.org · 30 Sept 2026
Support: The project directs users to Stack Overflow, GitHub Discussions, GitHub Issues, or the sphinx-users mailing list for questions and problem reports.sphinx-doc.org · 30 Sept 2026
Project audience: The documentation describes Sphinx as community supported and welcomes contributions from anyone.sphinx-doc.org · 30 Sept 2026
Themes: Sphinx includes built-in and third-party HTML themes and supports custom themes.sphinx-doc.org · 30 Sept 2026
Extensions: Sphinx provides extension mechanisms and built-in and third-party extensions for tasks such as diagrams and code testing.sphinx-doc.org · 30 Sept 2026
Docker: Official Docker images include sphinxdoc/sphinx for standard use and sphinxdoc/sphinx-latexpdf for LaTeX PDF builds.sphinx-doc.org · 30 Sept 2026
Deployment integrations: The documentation lists Read the Docs, GitHub Pages, GitLab Pages, Netlify and self-hosted servers as deployment options.sphinx-doc.org · 30 Sept 2026
Web API: Sphinx provides a Python API for integrating documentation into web applications, but its Web Support feature has had limited adoption and development.sphinx-doc.org · 30 Sept 2026
Support model: Sphinx is community supported and welcomes contributions from anybody, with tutorials, forums, examples and contributor resources.sphinx-doc.org · 30 Sept 2026
License and warranty: Sphinx code is released under the two-clause BSD license, with warranty disclaimers in the license text.github.com · 30 Sept 2026