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 --------------------------------------- * Blinker: https://pythonhosted.org/blinker/ * Calibre: https://manual.calibre-ebook.com/ * CodePy: https://documen.tician.de/codepy/ * Fityk: http://fityk.nieto.pl/ * Flask: http://flask.pocoo.org/docs/ * Flask-OpenID: https://pythonhosted.org/Flask-OpenID/ * Jinja: http://jinja.pocoo.org/docs/ * Lino: http://www.lino-framework.org/ (customized) * MeshPy: https://documen.tician.de/meshpy/ * PyCUDA: https://documen.tician.de/pycuda/ * PyOpenCL: https://documen.tician.de/pyopencl/ * PyLangAcq: http://pylangacq.org/ * python-apt: https://apt.alioth.debian.org/python-apt-doc/ * PyVisfile: https://documen.tician.de/pyvisfile/ * Tablib: http://docs.python-tablib.org/ * Werkzeug: http://werkzeug.pocoo.org/docs/ (customized) Documentation using the classic theme ------------------------------------- * Advanced Generic Widgets: http://xoomer.virgilio.it/infinity77/AGW_Docs/ (customized) * APSW: https://rogerbinns.github.io/apsw/ * Arb: http://arblib.org/ * Bazaar: http://doc.bazaar.canonical.com/ (customized) * Blender: https://docs.blender.org/api/current/ * Chaco: http://docs.enthought.com/chaco/ (customized) * Cormoran: http://cormoran.nhopkg.org/docs/ * DEAP: https://deap.readthedocs.io/ (customized) * Director: https://pythonhosted.org/director/ * EZ-Draw: https://pageperso.lif.univ-mrs.fr/~edouard.thiel/ez-draw/doc/en/html/ez-manual.html (customized) * F2py: http://f2py.sourceforge.net/docs/ * Genomedata: https://noble.gs.washington.edu/proj/genomedata/doc/1.3.3/ * GetFEM++: http://getfem.org/ (customized) * Glasgow Haskell Compiler: https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/ (customized) * Grok: http://grok.zope.org/doc/current/ (customized) * GROMACS: http://manual.gromacs.org/documentation/ * GSL Shell: http://www.nongnu.org/gsl-shell/ * Hands-on Python Tutorial: http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/ * Kaa: http://api.freevo.org/kaa-base/ (customized) * Leo: http://leoeditor.com/ * LEPL: http://www.acooke.org/lepl/ (customized) * Mayavi: http://docs.enthought.com/mayavi/mayavi/ (customized) * mpmath: http://mpmath.org/doc/current/ * OpenCV: http://docs.opencv.org/ (customized) * OpenEXR: http://excamera.com/articles/26/doc/index.html * OpenGDA: http://www.opengda.org/gdadoc/html/ * Peach^3: https://peach3.nl/doc/latest/userdoc/ (customized) * PyEMD: https://pyemd.readthedocs.io/ * Pyevolve: http://pyevolve.sourceforge.net/ * Pygame: https://www.pygame.org/docs/ (customized) * PyMQI: https://pythonhosted.org/pymqi/ * Python 2: https://docs.python.org/2/ * Python 3: https://docs.python.org/3/ (customized) * Ring programming language: http://ring-lang.sourceforge.net/doc/ (customized) * SageMath: https://doc.sagemath.org/ (customized) * Segway: http://noble.gs.washington.edu/proj/segway/doc/1.1.0/segway.html * simuPOP: http://simupop.sourceforge.net/manual_release/build/userGuide.html (customized) * Sprox: http://sprox.org/ (customized) * SymPy: http://docs.sympy.org/ * TurboGears: https://turbogears.readthedocs.org/ (customized) * tvtk: http://docs.enthought.com/mayavi/tvtk/ * Varnish: https://www.varnish-cache.org/docs/ (customized, alabaster for index) * Waf: https://waf.io/apidocs/ * wxPython Phoenix: https://wxpython.org/Phoenix/docs/html/main.html (customized) * z3c: http://www.ibiblio.org/paulcarduner/z3ctutorial/ * zc.async: https://pythonhosted.org/zc.async/ (customized) * Zope: https://docs.zope.org/zope2/ (customized) Documentation using the sphinxdoc theme --------------------------------------- * Matplotlib: https://matplotlib.org/ * NetworkX: https://networkx.github.io/ * PyCantonese: http://pycantonese.org/ * Pyre: http://docs.danse.us/pyre/sphinx/ * pySPACE: https://pyspace.github.io/pyspace/ * Pysparse: http://pysparse.sourceforge.net/ * PyTango: http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango/latest/ * Python Wild Magic: https://vmlaker.github.io/pythonwildmagic/ (customized) * Reteisi: http://www.reteisi.org/contents.html (customized) * Sqlkit: http://sqlkit.argolinux.org/ (customized) * Turbulenz: http://docs.turbulenz.com/ Documentation using the nature theme ------------------------------------ * Cython: http://docs.cython.org/ * jsFiddle: http://doc.jsfiddle.net/ * libLAS: https://www.liblas.org/ (customized) * MapServer: http://mapserver.org/ (customized) * Setuptools: https://setuptools.readthedocs.io/ * Spring Python: https://docs.spring.io/spring-python/1.2.x/sphinx/html/ * Sylli: http://sylli.sourceforge.net/ Documentation using another builtin theme ----------------------------------------- * MPipe: https://vmlaker.github.io/mpipe/ (sphinx13) * Programmieren mit PyGTK und Glade (German): http://www.florian-diesch.de/doc/python-und-glade/online/ (agogo, customized) * PyPubSub: https://pypubsub.readthedocs.io/ (bizstyle) * Pylons: http://docs.pylonsproject.org/projects/pylons-webframework/ (pyramid) * Pyramid web framework: https://docs.pylonsproject.org/projects/pyramid/ (pyramid) * Valence: http://docs.valence.desire2learn.com/ (haiku) Documentation using sphinx_rtd_theme ------------------------------------ * ASE: https://wiki.fysik.dtu.dk/ase/ * Elemental: http://libelemental.org/documentation/dev/ * ESWP3: https://eswp3.readthedocs.io/ * GPAW: https://wiki.fysik.dtu.dk/gpaw/ (customized) * Linguistica: https://linguistica-uchicago.github.io/lxa5/ * MathJax: https://docs.mathjax.org/ * MoinMoin: https://moin-20.readthedocs.io/ * MyHDL: http://docs.myhdl.org/ * NICOS: https://forge.frm2.tum.de/nicos/doc/nicos-master/ (customized) * pip: https://pip.pypa.io/ * Paver: https://paver.readthedocs.io/ * Pweave: http://mpastell.com/pweave/ * python-sqlparse: https://sqlparse.readthedocs.io/ * Free your information from their silos (French): http://redaction-technique.org/ (customized) * Quex: http://quex.sourceforge.net/doc/html/main.html * Satchmo: http://docs.satchmoproject.com/ * Scapy: https://scapy.readthedocs.io/ * SimPy: http://simpy.readthedocs.io/ * Tango Controls: https://tango-controls.readthedocs.io/ (customized) * Tuleap: https://tuleap.net/doc/en/ Documentation using sphinx_bootstrap_theme ------------------------------------------ * C/C++ Software Development with Eclipse: http://eclipsebook.in/ * e-cidadania: http://e-cidadania.readthedocs.org/ * Hedge: https://documen.tician.de/hedge/ * Open Dylan: https://opendylan.org/documentation/ * PyUblas: https://documen.tician.de/pyublas/ Documentation using a custom theme or integrated in a website ------------------------------------------------------------- * CakePHP: https://book.cakephp.org/ * Ceph: http://docs.ceph.com/docs/master/ * Chef: https://docs.chef.io/ * Django: https://docs.djangoproject.com/ * Enterprise Toolkit for Acrobat products: https://www.adobe.com/devnet-docs/acrobatetk/ * Gameduino: http://excamera.com/sphinx/gameduino/ * GeoServer: http://docs.geoserver.org/ * gevent: http://www.gevent.org/ * Guzzle: http://docs.guzzlephp.org/en/stable/ * Istihza (Turkish Python documentation project): https://belgeler.yazbel.com/python-istihza/ * Lasso: http://lassoguide.com/ * MirrorBrain: http://mirrorbrain.org/docs/ * Music21: http://web.mit.edu/music21/doc/ * nose: https://nose.readthedocs.io/ * NumPy: https://docs.scipy.org/doc/numpy/reference/ * ObjectListView: http://objectlistview.sourceforge.net/python/ * OpenERP: https://doc.odoo.com/ * OpenCV: http://docs.opencv.org/ * OpenLayers: http://docs.openlayers.org/ * PyEphem: http://rhodesmill.org/pyephem/ * Pygments: http://pygments.org/docs/ * Plone User Manual (German): https://www.hasecke.com/plone-benutzerhandbuch/4.0/ * PSI4: http://www.psicode.org/psi4manual/master/index.html * PyMOTW: https://pymotw.com/2/ * python-aspectlib: https://python-aspectlib.readthedocs.io/ (`sphinx_py3doc_enhanced_theme `__) * QGIS: https://qgis.org/en/docs/index.html * qooxdoo: http://www.qooxdoo.org/current/ * Roundup: http://www.roundup-tracker.org/ * scikit-learn: http://scikit-learn.org/stable/ * SciPy: https://docs.scipy.org/doc/scipy/refrence/ * Seaborn: https://seaborn.pydata.org/ * Selenium: http://docs.seleniumhq.org/docs/ * Self: http://www.selflanguage.org/ * Substance D: https://docs.pylonsproject.org/projects/substanced/ * SQLAlchemy: https://docs.sqlalchemy.org/ * tinyTiM: http://tinytim.sourceforge.net/docs/2.0/ * Ubuntu Packaging Guide: http://packaging.ubuntu.com/html/ * WebFaction: https://docs.webfaction.com/ * WTForms: https://wtforms.readthedocs.io/ Homepages and other non-documentation sites ------------------------------------------- * Benoit Boissinot: https://bboissin.appspot.com/ (modified classic) * Computer Networks, Parallelization, and Simulation Laboratory (CNPSLab): https://lab.miletic.net/ (sphinx_rtd_theme) * Loyola University Chicago COMP 339-439 Distributed Systems course: http://books.cs.luc.edu/distributedsystems/ (sphinx_bootstrap_theme) * The Wine Cellar Book: https://www.thewinecellarbook.com/doc/en/ (sphinxdoc) * UC Berkeley ME233 Advanced Control Systems II course: https://berkeley-me233.github.io/ (sphinxdoc) Books produced using Sphinx --------------------------- * "Die Wahrheit des Sehens. Der DEKALOG von Krzysztof Kieślowski": https://literatur.hasecke.com/post/die-wahrheit-des-sehens-dekalog-kieslowski/ * "Expert Python Programming": https://www.packtpub.com/application-development/expert-python-programming * "Expert Python Programming" (Japanese translation): https://www.amazon.co.jp/dp/4048686291/ * "LassoGuide": http://www.lassosoft.com/Lasso-Documentation * "Learning Sphinx" (in Japanese): https://www.oreilly.co.jp/books/9784873116488/ * "Pioneers and Prominent Men of Utah": http://pioneers.rstebbing.com/ * "Pomodoro Technique Illustrated" (Japanese translation): https://www.amazon.co.jp/dp/4048689525/ * "Python Professional Programming" (in Japanese): https://www.amazon.co.jp/dp/4798032948/ * "The ``repoze.bfg`` Web Application Framework": https://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379 * "Simple and Steady Way of Learning for Software Engineering" (in Japanese): https://www.amazon.co.jp/dp/477414259X/ * "Software-Dokumentation mit Sphinx": https://www.amazon.de/dp/1497448689/ * "Theoretical Physics Reference": http://www.theoretical-physics.net/ * "The Varnish Book": https://info.varnish-software.com/the-varnish-book Theses produced 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 * "Content Conditioning and Distribution for Dynamic Virtual Worlds": https://www.cs.princeton.edu/research/techreps/TR-941-12 * "The Sphinx Thesis Resource": https://jterrace.github.io/sphinxtr/