Projects using Sphinx — Sphinx 1.4 documentation

- Home
- Get it
- Docs
- Extend/Develop

# Projects using Sphinx

This is an (incomplete) alphabetic list of projects that use Sphinx or are experimenting with using it for their documentation. If you like to be included, please mail to the Google group.

I’ve grouped the list into sections to make it easier to find interesting examples.

## Documentation using the alabaster theme

- PyLangAcq: http://pylangacq.org/

## Documentation using the classic theme

- APSW: http://apidoc.apsw.googlecode.com/hg/index.html
- ASE: https://wiki.fysik.dtu.dk/ase/
- Calibre: http://manual.calibre-ebook.com/
- CodePy: https://documen.tician.de/codepy/
- Cython: http://docs.cython.org/
- Cormoran: http://cormoran.nhopkg.org/docs/
- Director: http://pythonhosted.org/director/
- Dirigible: http://www.projectdirigible.com/
- F2py: http://f2py.sourceforge.net/docs/
- GeoDjango: https://docs.djangoproject.com/en/dev/ref/contrib/gis/
- Genomedata: http://noble.gs.washington.edu/proj/genomedata/doc/1.2.2/genomedata.html
- gevent: http://www.gevent.org/
- Google Wave API: http://wave-robot-python-client.googlecode.com/svn/trunk/pydocs/index.html
- GSL Shell: http://www.nongnu.org/gsl-shell/
- Heapkeeper: http://heapkeeper.org/
- Hands-on Python Tutorial: http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/
- Hedge: https://documen.tician.de/hedge/
- Leo: http://leoeditor.com/
- Lino: http://www.lino-framework.org/
- MeshPy: https://documen.tician.de/meshpy/
- mpmath: http://mpmath.googlecode.com/svn/trunk/doc/build/index.html
- OpenEXR: http://excamera.com/articles/26/doc/index.html
- OpenGDA: http://www.opengda.org/gdadoc/html/
- openWNS: http://docs.openwns.org/
- Paste: http://pythonpaste.org/script/
- Paver: http://paver.github.io/paver/
- Pioneers and Prominent Men of Utah: http://pioneers.rstebbing.com/
- PyCantonese: http://pycantonese.org/
- Pyccuracy: https://github.com/heynemann/pyccuracy/wiki/
- PyCuda: https://documen.tician.de/pycuda/
- Pyevolve: http://pyevolve.sourceforge.net/
- Pylo: https://documen.tician.de/pylo/
- PyMQI: http://pythonhosted.org/pymqi/
- PyPubSub: http://pubsub.sourceforge.net/
- pySPACE: http://pyspace.github.io/pyspace/
- Python: https://docs.python.org/3/
- python-apt: http://apt.alioth.debian.org/python-apt-doc/
- PyUblas: https://documen.tician.de/pyublas/
- Quex: http://quex.sourceforge.net/doc/html/main.html
- Ring programming language: http://ring-lang.sourceforge.net/doc/index.html
- Scapy: http://www.secdev.org/projects/scapy/doc/
- Segway: http://noble.gs.washington.edu/proj/segway/doc/1.1.0/segway.html
- SimPy: http://simpy.readthedocs.org/en/latest/
- SymPy: http://docs.sympy.org/
- WTForms: http://wtforms.simplecodes.com/docs/
- z3c: http://www.ibiblio.org/paulcarduner/z3ctutorial/

## Documentation using a customized version of the classic theme

- Advanced Generic Widgets: http://xoomer.virgilio.it/infinity77/AGW_Docs/index.html
- Arb: http://fredrikj.net/arb/
- Bazaar: http://doc.bazaar.canonical.com/en/
- CakePHP: http://book.cakephp.org/2.0/en/index.html
- Chaco: http://docs.enthought.com/chaco/
- Chef: https://docs.chef.io/index.html
- Djagios: http://djagios.org/
- EZ-Draw: http://pageperso.lif.univ-mrs.fr/~edouard.thiel/ez-draw/doc/en/html/ez-manual.html
- GetFEM++: http://home.gna.org/getfem/
- Google or-tools: https://or-tools.googlecode.com/svn/trunk/documentation/user_manual/index.html
- GPAW: https://wiki.fysik.dtu.dk/gpaw/
- Grok: http://grok.zope.org/doc/current/
- Kaa: http://api.freevo.org/kaa-base/
- LEPL: http://www.acooke.org/lepl/
- Mayavi: http://docs.enthought.com/mayavi/mayavi/
- NICOS: http://trac.frm2.tum.de/nicos/doc/nicos-master/index.html
- NOC: http://redmine.nocproject.org/projects/noc
- NumPy: http://docs.scipy.org/doc/numpy/reference/
- OpenCV: http://docs.opencv.org/
- Peach^3: http://peach3.nl/doc/latest/userdoc/
- Sage: http://www.sagemath.org/doc/
- SciPy: http://docs.scipy.org/doc/scipy/reference/
- simuPOP: http://simupop.sourceforge.net/manual_release/build/userGuide.html
- Sprox: http://sprox.org/
- TurboGears: http://turbogears.readthedocs.org/en/latest/
- Varnish: https://www.varnish-cache.org/docs/
- Zentyal: http://doc.zentyal.org/
- Zope: http://docs.zope.org/zope2/index.html
- zc.async: http://pythonhosted.org/zc.async/1.5.0/

## Documentation using the sphinxdoc theme

- Fityk: http://fityk.nieto.pl/
- MapServer: http://mapserver.org/
- Matplotlib: http://matplotlib.org/
- Music21: http://web.mit.edu/music21/doc/index.html
- NetworkX: http://networkx.github.io/
- Pweave: http://mpastell.com/pweave/
- Pyre: http://docs.danse.us/pyre/sphinx/
- Pysparse: http://pysparse.sourceforge.net/
- PyTango: http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango/latest/index.html
- Python Wild Magic: http://vmlaker.github.io/pythonwildmagic/
- Reteisi: http://www.reteisi.org/contents.html
- Sqlkit: http://sqlkit.argolinux.org/
- Turbulenz: http://docs.turbulenz.com/
- WebFaction: https://docs.webfaction.com/

## Documentation using another builtin theme

- C/C++ Development with Eclipse: http://eclipsebook.in/ (agogo)
- ESWP3 (http://eswp3.org) (sphinx_rtd_theme)
- Jinja: http://jinja.pocoo.org/ (scrolls)
- jsFiddle: http://doc.jsfiddle.net/ (nature)
- libLAS: http://www.liblas.org/ (nature)
- Linguistica: http://linguistica-uchicago.github.io/lxa5/ (sphinx_rtd_theme)
- MPipe: http://vmlaker.github.io/mpipe/ (sphinx13)
- pip: https://pip.pypa.io/en/latest/ (sphinx_rtd_theme)
- Pyramid web framework: http://docs.pylonsproject.org/projects/pyramid/en/latest/ (pyramid)
- Programmieren mit PyGTK und Glade (German): http://www.florian-diesch.de/doc/python-und-glade/online/ (agogo)
- Satchmo: http://docs.satchmoproject.com/en/latest/ (sphinx_rtd_theme)
- Setuptools: http://pythonhosted.org/setuptools/ (nature)
- Spring Python: http://docs.spring.io/spring-python/1.2.x/sphinx/html/ (nature)
- sqlparse: http://python-sqlparse.googlecode.com/svn/docs/api/index.html (agogo)
- Sylli: http://sylli.sourceforge.net/ (nature)
- Tuleap Open ALM: https://tuleap.net/doc/en/ (nature)
- Valence: http://docs.valence.desire2learn.com/ (haiku)

## Documentation using a custom theme/integrated in a site

- Blender: https://www.blender.org/api/250PythonDoc/
- Blinker: http://discorporate.us/projects/Blinker/docs/
- Ceph: http://docs.ceph.com/docs/master/
- Classy: http://www.pocoo.org/projects/classy/
- DEAP: http://deap.gel.ulaval.ca/doc/0.8/index.html
- Django: https://docs.djangoproject.com/
- Elemental: http://libelemental.org/documentation/dev/index.html
- Enterprise Toolkit for Acrobat products: http://www.adobe.com/devnet-docs/acrobatetk/
- e-cidadania: http://e-cidadania.readthedocs.org/en/latest/
- Flask: http://flask.pocoo.org/docs/
- Flask-OpenID: http://pythonhosted.org/Flask-OpenID/
- Gameduino: http://excamera.com/sphinx/gameduino/
- GeoServer: http://docs.geoserver.org/
- GHC - Glasgow Haskell Compiler: http://downloads.haskell.org/~ghc/master/users-guide/
- Glashammer: http://glashammer.org/
- Istihza (Turkish Python documentation project): http://belgeler.istihza.com/py2/
- Lasso: http://lassoguide.com/
- Manage documentation such as source code (fr): http://redaction-technique.org/
- MathJax: http://docs.mathjax.org/en/latest/
- MirrorBrain: http://mirrorbrain.org/docs/
- MyHDL: http://docs.myhdl.org/en/latest/
- nose: http://nose.readthedocs.org/en/latest/
- NoTex: https://www.notex.ch/overview/
- ObjectListView: http://objectlistview.sourceforge.net/python/
- Open ERP: https://doc.odoo.com/
- OpenCV: http://docs.opencv.org/
- Open Dylan: http://opendylan.org/documentation/
- OpenLayers: http://docs.openlayers.org/
- PyEphem: http://rhodesmill.org/pyephem/
- German Plone user manual: http://www.hasecke.com/plone-benutzerhandbuch/
- PSI4: http://www.psicode.org/psi4manual/master/index.html
- Pylons: http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/
- PyMOTW: https://pymotw.com/2/
- python-aspectlib: http://python-aspectlib.readthedocs.org/en/latest/ (sphinx-py3doc-enhanced-theme)
- QGIS: http://qgis.org/en/docs/index.html
- qooxdoo: http://manual.qooxdoo.org/current/
- Roundup: http://www.roundup-tracker.org/
- Selenium: http://docs.seleniumhq.org/docs/
- Self: http://www.selflanguage.org/
- Substance D: http://docs.pylonsproject.org/projects/substanced/en/latest/
- Tablib: http://tablib.org/
- SQLAlchemy: http://www.sqlalchemy.org/docs/
- tinyTiM: http://tinytim.sourceforge.net/docs/2.0/
- Ubuntu packaging guide: http://packaging.ubuntu.com/html/
- Werkzeug: http://werkzeug.pocoo.org/docs/
- WFront: http://discorporate.us/projects/WFront/

## Homepages and other non-documentation sites

- A personal page: http://www.dehlia.in/
- Benoit Boissinot: http://bboissin.appspot.com/
- lunarsite: http://lunaryorn.de/
- The Wine Cellar Book: http://www.thewinecellarbook.com/doc/en/
- UC Berkeley Advanced Control Systems course: http://msc.berkeley.edu/tomizuka/me233spring13/
- VOR: http://www.vor-cycling.be/

## Books produced using Sphinx

- “The `repoze.bfg` Web Application Framework”: http://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379
- A Theoretical Physics Reference book: http://www.theoretical-physics.net/
- “Simple and Steady Way of Learning for Software Engineering” (in Japanese): http://www.amazon.co.jp/dp/477414259X/
- “Expert Python Programming”: https://www.packtpub.com/application-development/expert-python-programming
- “Expert Python Programming” (Japanese translation): http://www.amazon.co.jp/dp/4048686291/
- “Pomodoro Technique Illustrated” (Japanese translation): http://www.amazon.co.jp/dp/4048689525/
- “Python Professional Programming” (in Japanese): http://www.amazon.co.jp/dp/4798032948/
- “Die Wahrheit des Sehens. Der DEKALOG von Krzysztof Kieślowski”: http://www.hasecke.eu/Dekalog/
- The “Varnish Book”: http://book.varnish-software.com/4.0/
- “Learning Sphinx” (in Japanese): http://www.oreilly.co.jp/books/9784873116488/
- “LassoGuide”: http://www.lassosoft.com/Lasso-Documentation
- “Software-Dokumentation mit Sphinx”: http://www.amazon.de/dp/1497448689/

## Thesis using Sphinx

- “A Web-Based System for Comparative Analysis of OpenStreetMap Data by the Use of CouchDB”: https://www.yumpu.com/et/document/view/11722645/masterthesis-markusmayr-0542042