Sphinx vs TypeDoc
Sphinx
sphinx-doc.orgTypeDoc
typedoc.orgSide by side
| Figure | Sphinx | TypeDoc |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Web | Yes | — |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | Yes |
| API | Yes | Yes |
| Self-hosted | Yes | Yes |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.2 (#7) | 8.0 (#10) |
| Installation | Sphinx is a Python application installable through PyPI, Conda, Linux package managers, Homebrew or MacPorts, Chocolatey, Docker, or from source. | TypeDoc runs on Node.js and is available as an npm package. |
| Integrations | Built-in extensions include GitHub Pages publishing, Graphviz graphs, and intersphinx links to other projects’ documentation. | The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. |
| License | The project states that its code is released under the two-clause BSD license. | The TypeDoc repository identifies its license as Apache-2.0. |
| Output formats | Sphinx generates HTML, LaTeX for PDF, ePub, Texinfo and other documentation formats. | The default output is HTML, and TypeDoc can also write a JSON model describing the project. |
| Purpose | Sphinx generates technical documentation from structured text. | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. |
| Support | The project directs users to Stack Overflow, GitHub Discussions, GitHub Issues, or the sphinx-users mailing list for questions and problem reports. | The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. |
Plans
In their own words
Sphinx
Sphinx is a free Python application that generates technical documentation from structured text. Authors can use reStructuredText or MyST Markdown; Markdown requires installing MyST-Parser separately. Built-in builders produce HTML, LaTeX for PDF, ePub, manual pages, Texinfo, and plain text. References can link sections, figures, tables, citations, glossaries, and code objects within one project or across projects. The autodoc extension imports documented modules and includes material from their docstrings. Themes and extensions, both built-in and third-party, add options such as diagrams, doctests, and API documentation. Other built-in extensions provide GitHub Pages publishing, Graphviz graphs, and intersphinx links. Sphinx also supports gettext-based translation and full-text search. It can be installed through Python and platform package managers, Docker, or from source, then deployed to services such as Read the Docs, GitHub Pages, GitLab Pages, Netlify, or self-hosted servers. Its code is released under the two-clause BSD license, and the project is community supported.
TypeDoc
TypeDoc is a free TypeScript documentation generator that turns source comments into HTML pages or a JSON model. It builds from project exports and follows re-exports, allowing members declared elsewhere to appear in documentation. TSDoc and JSDoc tags are extracted, Markdown is accepted in comments, and fenced code blocks receive Shiki syntax highlighting. HTML and JSON are built in; Markdown output needs a plugin such as typedoc-plugin-markdown. A default theme is included, while plugins can add themes, alter conversion and symbol organization, or change display. Custom CSS and JavaScript can further adjust generated pages. Configuration can come from an options file, package.json, or tsconfig.json. TypeDoc runs on Node.js, uses the TypeScript compiler, and supports the current Node.js LTS or newer. For npm monorepos, the packages entry-point strategy can combine package documentation into one site. The project is Apache-2.0 licensed. Documentation warns that global installation can separate plugins and themes from the intended TypeDoc installation.