Sphinx

(Python Documentation Generator)

Note

This project is under active development.

Quick start

Assuming you have Python already, install Sphinx:

pip install sphinx

Now that you have added some files and content, let’s make a first build of the docs. A build is started with the sphinx-build program:

sphinx-build -b html sourcedir builddir

where sourcedir is the source directory, and builddir is the directory in which you want to place the built documentation. The -b option selects a builder; in this example Sphinx will build HTML files.

Building your HTML documentation

sphinx-build -b html source/ build/html

Getting Started with Sphinx

1. Sphinx Official Website

2. Sphinx Github Repository

3. Sphinx Documentation

4. Sphinx Themes

5. Sphinx Extensions

6. Read the Docs

7. reStructuredText Manual

8. reStructuredText:Markup Syntax and Parser Component of Docutils

9. Quick reStructuredText

10. Create Documentation with RST, Sphinx, Sublime, and GitHub