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

• Alabaster

• Blinker

• Calibre

• Click (customized)

• coala (customized)

• CodePy

• Eve (Python REST API framework)

• Fabric

• Fityk

• Flask

• Flask-OpenID

• Invoke

• Jinja

• Lino (customized)

• marbl

• MDAnalysis (customized)

• MeshPy

• Molecule

• PyCUDA

• PyOpenCL

• PyLangAcq

• pytest (customized)

• python-apt

• PyVisfile

• Requests

• searx

• Spyder (customized)

• Tablib

• urllib3 (customized)

• Werkzeug

• Write the Docs

Documentation using the classic theme

• Advanced Generic Widgets (customized)

• Apache CouchDB (customized)

• APSW

• Arb

• Bazaar (customized)

• Beautiful Soup

• Blender API

• Bugzilla

• Buildbot

• CMake (customized)

• Chaco (customized)

• CORE

• CORE Python modules

• Cormoran

• DEAP (customized)

• Director

• EZ-Draw (customized)

• F2py

• Generic Mapping Tools (GMT) (customized)

• Genomedata

• GetFEM++ (customized)

• Glasgow Haskell Compiler (customized)

• Grok (customized)

• GROMACS

• GSL Shell

• Hands-on Python Tutorial

• Kaa (customized)

• Leo

• LEPL (customized)

• Mayavi (customized)

• MediaGoblin (customized)

• mpmath

• OpenCV (customized)

• OpenEXR

• OpenGDA

• Peach^3 (customized)

• Plone (customized)

• PyEMD

• Pyevolve

• Pygame (customized)

• PyMQI

• PyQt4 (customized)

• PyQt5 (customized)

• Python 2

• Python 3 (customized)

• Python Packaging Authority (customized)

• Ring programming language (customized)

• SageMath (customized)

• Segway

• simuPOP (customized)

• Sprox (customized)

• SymPy

• TurboGears (customized)

• tvtk

• Varnish (customized, alabaster for index)

• Waf

• wxPython Phoenix (customized)

• Yum

• z3c

• zc.async (customized)

• Zope (customized)

Documentation using the sphinxdoc theme

• ABRT

• cartopy

• Jython

• LLVM

• Matplotlib

• MDAnalysis Tutorial

• NetworkX

• PyCantonese

• Pyre

• pySPACE

• Pysparse

• PyTango

• Python Wild Magic (customized)

• RDKit

• Reteisi (customized)

• Sqlkit (customized)

• Turbulenz

Documentation using the nature theme

• Alembic

• Cython

• easybuild

• jsFiddle

• libLAS (customized)

• Lmod

• MapServer (customized)

• Pandas

• pyglet (customized)

• PyWavelets

• Setuptools

• Spring Python

• StatsModels (customized)

• Sylli

Documentation using another builtin theme

• Breathe (haiku)

• MPipe (sphinx13)

• NLTK (agogo)

• Programmieren mit PyGTK und Glade (German) (agogo, customized)

• PyPubSub (bizstyle)

• Pylons (pyramid)

• Pyramid web framework (pyramid)

• RxDock

• Sphinx (sphinx13) :-)

• Valence (haiku, customized)

Documentation using sphinx_rtd_theme

• Annotator

• Ansible (customized)

• Arcade

• aria2

• ASE

• asvin

• Autofac

• BigchainDB

• Blender Reference Manual

• Blocks

• bootstrap-datepicker

• Certbot

• Chainer (customized)

• CherryPy

• cloud-init

• CodeIgniter

• Conda

• Corda

• Dask

• Databricks (customized)

• Dataiku DSS

• DNF

• Django-cas-ng

• edX

• Electrum

• Elemental

• ESWP3

• Ethereum Homestead

• Exhale

• Faker

• Fidimag

• Flake8

• Flatpak

• FluidDyn

• Fluidsim

• Gallium

• GeoNode

• Glances

• Godot

• Graylog

• GPAW (customized)

• HDF5 for Python (h5py)

• Hyperledger Fabric

• Hyperledger Sawtooth

• IdentityServer

• Idris

• javasphinx

• Julia

• Jupyter Notebook

• Lasagne

• latexindent.pl

• Learning Apache Spark with Python

• LibCEED

• Linguistica

• Linux kernel

• Mailman

• MathJax

• MDTraj (customized)

• Mesa 3D

• micca - MICrobial Community Analysis

• MicroPython

• Minds (customized)

• Mink

• Mockery

• mod_wsgi

• MoinMoin

• Mopidy

• mpi4py

• MyHDL

• Nextflow

• NICOS (customized)

• OpenFAST

• Pelican

• picamera

• Pillow

• pip

• Paver

• peewee

• Phinx

• phpMyAdmin

• PROS (customized)

• Pushkin

• Pweave

• PyPy

• python-sqlparse

• PyVISA

• pyvista

• Read The Docs

• ROCm Platform

• Free your information from their silos (French) (customized)

• Releases Sphinx extension

• Qtile

• Quex

• QuTiP

• Satchmo

• Scapy

• SimGrid

• SimPy

• six

• SlamData

• Solidity

• Sonos Controller (SoCo)

• Sphinx AutoAPI

• sphinx-argparse

• Sphinx-Gallery (customized)

• Sphinx with Github Webpages

• SpotBugs

• StarUML

• Sublime Text Unofficial Documentation

• SunPy

• Sylius

• Syncthing

• Tango Controls (customized)

• Topshelf

• Theano

• ThreatConnect

• Tuleap

• TYPO3 (customized)

• Veyon

• uWSGI

• virtualenv

• Wagtail

• Web Application Attack and Audit Framework (w3af)

• Weblate

• x265

• Zulip

Documentation using sphinx_bootstrap_theme

• Bootstrap Theme

• C/C++ Software Development with Eclipse

• Dataverse

• e-cidadania

• Hangfire

• Hedge

• ObsPy

• Open Dylan

• OPNFV

• Pootle

• PyUblas

• seaborn

Documentation using a custom theme or integrated in a website

• AIOHTTP

• Apache Cassandra

• Astropy

• Bokeh

• Boto 3

• CakePHP

• CasperJS

• Ceph

• Chef

• CKAN

• Confluent Platform

• Django

• Doctrine

• Enterprise Toolkit for Acrobat products

• FreeFEM

• fmt

• Gameduino

• gensim

• GeoServer

• gevent

• GHC - Glasgow Haskell Compiler

• Guzzle

• H2O.ai

• Heka

• Istihza (Turkish Python documentation project)

• JupyterHub

• Kombu

• Lasso

• Mako

• MirrorBrain

• Mitiq

• MongoDB

• Music21

• MyHDL

• ndnSIM

• nose

• ns-3

• NumPy

• ObjectListView

• OpenERP

• OpenCV

• OpenLayers

• OpenTURNS

• Open vSwitch

• PlatformIO

• PyEphem

• Pygments

• Plone User Manual (German)

• PSI4

• PyMOTW

• python-aspectlib (sphinx_py3doc_enhanced_theme)

• QGIS

• qooxdoo

• Roundup

• SaltStack

• scikit-learn

• SciPy

• Scrapy

• Seaborn

• Selenium

• Self

• Substance D

• Sulu

• SQLAlchemy

• tinyTiM

• Twisted

• Ubuntu Packaging Guide

• WebFaction

• WTForms

Homepages and other non-documentation sites

• Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio-and Nanophysics (classic)

• Benoit Boissinot (classic, customized)

• Computer Networks, Parallelization, and Simulation Laboratory (CNPSLab) (sphinx_rtd_theme)

• Deep Learning Tutorials (sphinxdoc)

• Eric Holscher (alabaster)

• Lei Ma’s Statistical Mechanics lecture notes (sphinx_bootstrap_theme)

• Loyola University Chicago COMP 339-439 Distributed Systems course (sphinx_bootstrap_theme)

• Pylearn2 (sphinxdoc, customized)

• PyXLL (sphinx_bootstrap_theme, customized)

• SciPy Cookbook (sphinx_rtd_theme)

• Tech writer at work blog (custom theme)

• The Wine Cellar Book (sphinxdoc)

• Thomas Cokelaer’s Python, Sphinx and reStructuredText tutorials (standard)

• UC Berkeley ME233 Advanced Control Systems II course (sphinxdoc)

• Željko Svedružić’s Biomolecular Structure and Function Laboratory (BioSFLab) (sphinx_bootstrap_theme)

Books produced using Sphinx

• “The Art of Community” (Japanese translation)

• “Die Wahrheit des Sehens. Der DEKALOG von Krzysztof Kieślowski”

• “Expert Python Programming”

• “Expert Python Programming” (Japanese translation)

• “Expert Python Programming 2nd Edition” (Japanese translation)

• “The Hitchhiker’s Guide to Python”

• “LassoGuide”

• “Learning Sphinx” (in Japanese)

• “Learning System Programming with Go (Japanese)”

• “Mercurial: the definitive guide (Second edition)”

• “Mithril – The fastest clientside MVC (Japanese)”

• “Pioneers and Prominent Men of Utah”

• “Pomodoro Technique Illustrated” (Japanese translation)

• “Professional Software Development”

• “Python Professional Programming” (in Japanese)

• “Python Professional Programming 2nd Edition” (in Japanese)

• “Python Professional Programming 3rd Edition” (in Japanese)

• Python Course by Yuri Petrov (Russian)

• “Real World HTTP – Learning The Internet and Web Technology via its history and code (Japanese)”

• “Redmine Primer 5th Edition (in Japanese)”

• “The repoze.bfg Web Application Framework”

• “The Self-Taught Programmer” (Japanese translation)

• “Simple and Steady Way of Learning for Software Engineering” (in Japanese)

• “Software-Dokumentation mit Sphinx”

• “Theoretical Physics Reference”

• “The Varnish Book”

Theses produced using Sphinx

• “A Web-Based System for Comparative Analysis of OpenStreetMap Data by the Use of CouchDB”

• “Content Conditioning and Distribution for Dynamic Virtual Worlds”

• “The Sphinx Thesis Resource”

Projects integrating Sphinx functionality

• Read the Docs, a software-as-a-service documentation hosting platform, uses Sphinx to automatically build documentation updates that are pushed to GitHub.

• Spyder, the Scientific Python Development Environment, uses Sphinx in its help pane to render rich documentation for functions, classes and methods automatically or on-demand.