Sphinx

• Sphinx Cheatsheet

Built with Sphinx, a small tutorial about Sphinx.

What?

+--------+
|   rst  |+        +----------+
|  Files ||  ===>  |  Sphinx  |  ===>  HTML/PDF
+--------+|        +----------+
 +--------+

Installation

Installing the cutting edge version of Sphinx is straight forward.

sudo easy-install jinja  # <-- templating engine
wajig install mercurial  # <-- the version control system, sphinx developers use
checkouts=$HOME/checkouts  # <-- where we'll keep the checkout
mkdir -p $checkouts
cd $checkouts
hg clone http://bitbucket.org/birkenfeld/sphinx/
cd sphinx
sudo python setup.py install

Some resources

• Sphinx documentation
• here I got started (actually it was here at the bottom)
• Sphinx Templates

See also: