Sphinx is a powerful documentation generator that has many great features for writing technical documentation including:
- Generate web pages, printable PDFs, documents for e-readers (ePub), and more all from the same sources
- You can use reStructuredText or Markdown to write documentation
- An extensive system of cross-referencing code and documentation
- Syntax highlighted code samples
- A vibrant ecosystem of first and third-party extensions
Quick start video
This screencast will help you get started or you can read our guide below.
External resources
Here are some external resources to help you learn more about Sphinx.
- Sphinx documentation
- RestructuredText primer
- An introduction to Sphinx and Read the Docs for technical writers
- http://www.sphinx-doc.org
