| 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 |
| <https://groups.google.com/group/sphinx-users>`_. |
| |
| I've grouped the list into sections to make it easier to find |
| interesting examples. |
| |
| Documentation using the default theme |
| ------------------------------------- |
| |
| * APSW: http://apidoc.apsw.googlecode.com/hg/index.html |
| * ASE: https://wiki.fysik.dtu.dk/ase/ |
| * boostmpi: http://documen.tician.de/boostmpi/ |
| * Calibre: http://manual.calibre-ebook.com/ |
| * CodePy: http://documen.tician.de/codepy/ |
| * Cython: http://docs.cython.org/ |
| * C\\C++ Python language binding project: http://language-binding.net/index.html |
| * Cormoran: http://cormoran.nhopkg.org/docs/ |
| * Director: http://pythonhosted.org/director/ |
| * Dirigible: http://www.projectdirigible.com/documentation/ |
| * F2py: http://f2py.sourceforge.net/docs/ |
| * GeoDjango: http://geodjango.org/docs/ |
| * 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: http://documen.tician.de/hedge/ |
| * Leo: http://leoeditor.com/ |
| * Lino: http://lino.saffre-rumma.net/ |
| * MeshPy: http://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/ |
| * Pyccuracy: https://github.com/heynemann/pyccuracy/wiki/ |
| * PyCuda: http://documen.tician.de/pycuda/ |
| * Pyevolve: http://pyevolve.sourceforge.net/ |
| * Pylo: http://documen.tician.de/pylo/ |
| * PyMQI: http://pythonhosted.org/pymqi/ |
| * PyPubSub: http://pubsub.sourceforge.net/ |
| * pyrticle: http://documen.tician.de/pyrticle/ |
| * Python: http://docs.python.org/ |
| * python-apt: http://apt.alioth.debian.org/python-apt-doc/ |
| * PyUblas: http://documen.tician.de/pyublas/ |
| * Quex: http://quex.sourceforge.net/doc/html/main.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.sourceforge.net/SimPyDocs/index.html |
| * 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 default theme |
| ------------------------------------------------------------- |
| |
| * Advanced Generic Widgets: |
| http://xoomer.virgilio.it/infinity77/AGW_Docs/index.html |
| * Bazaar: http://doc.bazaar.canonical.com/en/ |
| * CakePHP: http://book.cakephp.org/2.0/en/index.html |
| * Chaco: http://docs.enthought.com/chaco/ |
| * Chef: http://docs.opscode.com/ |
| * Djagios: http://djagios.org/ |
| * 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/ |
| * IFM: http://fluffybunny.memebot.com/ifm-docs/index.html |
| * 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/ |
| * PyLit: http://pylit.berlios.de/ |
| * Sage: http://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.org/2.0/docs/ |
| * 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.tango-controls.org/static/PyTango/latest/doc/html/index.html |
| * Python Wild Magic: http://vmlaker.github.io/pythonwildmagic/ |
| * Reteisi: http://www.reteisi.org/contents.html |
| * Sqlkit: http://sqlkit.argolinux.org/ |
| * Tau: http://www.tango-controls.org/static/tau/latest/doc/html/index.html |
| * Total Open Station: http://tops.berlios.de/ |
| * Turbulenz: http://docs.turbulenz.com/ |
| * WebFaction: http://docs.webfaction.com/ |
| |
| |
| Documentation using another builtin theme |
| ----------------------------------------- |
| |
| * C/C++ Development with Eclipse: http://eclipsebook.in/ (agogo) |
| * Jinja: http://jinja.pocoo.org/ (scrolls) |
| * jsFiddle: http://doc.jsfiddle.net/ (nature) |
| * libLAS: http://www.liblas.org/ (nature) |
| * MPipe: http://vmlaker.github.io/mpipe/ (sphinx13) |
| * pip: http://pip.openplans.org/ (nature) |
| * 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) |
| * 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: http://www.blender.org/documentation/250PythonDoc/ |
| * Blinker: http://discorporate.us/projects/Blinker/docs/ |
| * Ceph: http://ceph.com/docs/master/ |
| * Classy: http://classy.pocoo.org/ |
| * DEAP: http://deap.gel.ulaval.ca/doc/0.8/index.html |
| * Django: http://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/ |
| * Glashammer: http://glashammer.org/ |
| * Istihza (Turkish Python documentation project): |
| http://www.istihza.com/py2/icindekiler_python.html |
| * Lasso: http://lassoguide.com/ |
| * 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://notex.ch/overview/ |
| * ObjectListView: http://objectlistview.sourceforge.net/python/ |
| * Open ERP: http://doc.openerp.com/ |
| * OpenCV: http://docs.opencv.org/ |
| * Open Dylan: http://opendylan.org/documentation/ and also provides a |
| `dylan domain <https://github.com/dylan-lang/sphinx-extensions/blob/master/dylandomain/reference.rst>`__ |
| * OpenLayers: http://docs.openlayers.org/ |
| * PyEphem: http://rhodesmill.org/pyephem/ |
| * German Plone user manual: http://www.hasecke.com/plone-benutzerhandbuch/ |
| * PSI4: http://sirius.chem.vt.edu/psi4manual/latest/index.html |
| * Pylons: http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/ |
| * PyMOTW: http://pymotw.com/2/ |
| * pypol: http://pypol.altervista.org/ (celery) |
| * QGIS: http://qgis.org/en/docs/index.html |
| * qooxdoo: http://manual.qooxdoo.org/current/ |
| * Roundup: http://www.roundup-tracker.org/ |
| * Satchmo: http://docs.satchmoproject.com/en/latest/ |
| * Selenium: http://docs.seleniumhq.org/docs/ |
| * Self: http://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/ |
| * tipfy: http://www.tipfy.org/docs/ |
| * 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 |
| ------------------------------------------- |
| |
| * Applied Mathematics at the Stellenbosch University: http://dip.sun.ac.za/ |
| * A personal page: http://www.dehlia.in/ |
| * Benoit Boissinot: http://bboissin.appspot.com/ |
| * lunarsite: http://lunaryorn.de/ |
| * Red Hot Chili Python: http://redhotchilipython.com/ |
| * The Wine Cellar Book: http://www.thewinecellarbook.com/doc/en/ |
| * UC Berkeley Advanced Control Systems course: |
| http://www.me.berkeley.edu/ME233/sp14/ |
| * 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://theoretical-physics.net/ |
| * "Simple and Steady Way of Learning for Software Engineering" (in Japanese): |
| http://www.amazon.co.jp/dp/477414259X/ |
| * "Expert Python Programming": |
| http://www.packtpub.com/expert-python-programming/book |
| * "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": |
| https://www.varnish-software.com/static/book/ |
| * "Learning Sphinx" (in Japanese): |
| http://www.oreilly.co.jp/books/9784873116488/ |
| * "LassoGuide": |
| http://www.lassosoft.com/Lasso-Documentation |
| |
| |
| Thesis using Sphinx |
| ------------------- |
| |
| * "A Web-Based System for Comparative Analysis of OpenStreetMap Data |
| by the Use of CouchDB": |
| http://gisforge.no-ip.org/files/MasterThesis_MarkusMayr_0542042.pdf |
