Projects using Sphinx
=====================
This is an incomplete list of projects that use Sphinx for their documentation.
If you would like to add a project, please `create an issue or pull request
on GitHub `_.
I've grouped the list into sections to make it easier to find
interesting examples.
Documentation using the alabaster theme
---------------------------------------
* `Alabaster `__
* `Blinker `__
* `Calibre `__
* `CherryPy `__
* `Click `__ (customized)
* `coala `__ (customized)
* `CodePy `__
* `Django Q `__
* `Eve `__ (Python REST API framework)
* `Fabric `__
* `Fityk `__
* `Flask `__
* `Flask-OpenID `__
* `Invoke `__
* `Jinja `__
* `Lino `__ (customized)
* `Linux kernel `__ (customized)
* `marbl `__
* `MeshPy `__
* `Molecule `__
* `Momotor LTI `__
* `Podman `__
* `PyCUDA `__
* `PyOpenCL `__
* `PyLangAcq `__
* `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 `__
* `Beautiful Soup `__
* `Blender API `__
* `Bugzilla `__
* `Buildbot `__
* `CMake `__ (customized)
* `Chaco `__ (customized)
* `DEAP `__ (customized)
* `Director `__
* `EZ-Draw `__ (customized)
* `Generic Mapping Tools (GMT) `__ (customized)
* `Genomedata `__
* `GetFEM `__ (customized)
* `Glasgow Haskell Compiler `__ (customized)
* `Grok `__ (customized)
* `GROMACS `__
* `GSL Shell `__
* `Hands-on Python Tutorial `__
* `Kaa `__ (customized)
* `Leo `__ (customized)
* `Mayavi `__ (customized)
* `MediaGoblin `__ (customized)
* `mpmath `__
* `OpenCV `__ (customized)
* `OpenEXR `__
* `OpenGDA `__
* `phpDocumentor `__ (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)
* `SymPy `__
* `TurboGears `__ (customized)
* `tvtk `__
* `Varnish `__ (customized, alabaster for index)
* `Waf `__
* `wxPython Phoenix `__ (customized)
* `z3c `__
* `zc.async `__ (customized)
* `Zope `__ (customized)
Documentation using the sphinxdoc theme
---------------------------------------
* `ABRT `__
* `cartopy `__
* `Jython `__
* `LLVM `__
* `PyCantonese `__
* `Pyre `__
* `pySPACE `__
* `Pysparse `__
* `PyTango `__
* `Python Wild Magic `__ (customized)
* `RDKit `__
* `Reteisi `__ (customized)
* `Turbulenz `__
Documentation using the nature theme
------------------------------------
* `Alembic `__
* `Cython `__
* `easybuild `__
* `libLAS `__ (customized)
* `Lmod `__
* `MapServer `__ (customized)
* `PyWavelets `__
* `Setuptools `__
* `Spring Python `__
* `StatsModels `__ (customized)
* `Sylli `__
Documentation using another builtin theme
-----------------------------------------
* `Breathe `__ (haiku)
* `Breezy (fork of Bazaar) `__ (agogo)
* `MPipe `__ (sphinx13)
* `NLTK `__ (agogo)
* `PyPubSub `__ (bizstyle)
* `Pylons `__ (pyramid)
* `Pyramid web framework `__ (pyramid)
* `RxDock `__ (bizstyle)
* `Sphinx `__ (sphinx13) :-)
* `Valence `__ (haiku, customized)
Documentation using Read the Docs Sphinx Theme
----------------------------------------------
`Read the Docs Sphinx Theme documentation `__
* `Aesara (fork of Theano) `__
* `Annotator `__
* `Ansible `__ (customized)
* `Arcade `__
* `aria2 `__
* `ASE `__
* `asvin `__
* `Autofac `__
* `BigchainDB `__
* `Blender Reference Manual `__
* `Blocks `__
* `bootstrap-datepicker `__
* `Certbot `__
* `CKAN `__
* `Copr Buildsystem `__ (customized)
* `Coreboot `__
* `Chainer `__ (customized)
* `citeproc-js `__
* `cloud-init `__
* `CodeIgniter `__
* `Conda `__
* `Corda `__
* `Dask `__
* `Databricks `__ (customized)
* `Dataiku DSS `__
* `DNF `__
* `Distro Tracker `__
* `Django-cas-ng `__
* `dj-stripe `__
* `edX `__
* `Electrum `__
* `ESWP3 `__
* `Ethereum Homestead `__
* `Exhale `__
* `Faker `__
* `Fidimag `__
* `Flake8 `__
* `Flatpak `__
* `FluidDyn `__
* `Fluidsim `__
* `Gallium `__
* `GeoNode `__
* `Glances `__
* `Godot `__
* `Graylog `__
* `GPAW `__ (customized)
* `HDF5 for Python (h5py) `__
* `HyperKitty `__
* `Hyperledger Fabric `__
* `IdentityServer `__
* `Idris `__
* `Inkscape `__ (customized)
* `javasphinx `__
* `Jupyter Notebook `__
* `Kanboard `__
* `Lasagne `__
* `latexindent.pl `__
* `Learning Apache Spark with Python `__
* `LibCEED `__
* `Linguistica `__
* `Mailman `__
* `MathJax `__
* `MDTraj `__ (customized)
* `Mesa 3D `__
* `micca - MICrobial Community Analysis `__
* `MicroPython `__
* `Mink `__
* `Mockery `__
* `mod_wsgi `__
* `MoinMoin `__
* `Mopidy `__
* `mpi4py `__
* `MyHDL `__
* `Mypy `__
* `Netgate Docs `__
* `Nextcloud Server `__
* `Nextflow `__
* `nghttp2 `__
* `NICOS `__ (customized)
* `OpenFAST `__
* `Panda3D `__ (customized)
* `Pelican `__
* `picamera `__
* `Pillow `__
* `pip `__
* `Paver `__
* `peewee `__
* `Phinx `__
* `phpMyAdmin `__
* `PHPUnit `__
* `PHPWord `__
* `PROS `__ (customized)
* `Pweave `__
* `pyca/cryptograhpy `__
* `pyglet `__
* `PyNaCl `__
* `pyOpenSSL `__
* `PyPy `__
* `python-sqlparse `__
* `PyVISA `__
* `Read The Docs `__
* `RenderDoc `__
* `ROCm Platform `__
* `Free your information from their silos (French) `__ (customized)
* `Releases Sphinx extension `__
* `Qtile `__
* `Quex `__
* `QuTiP `__
* `Sawtooth `__
* `Scapy `__
* `SimGrid `__
* `SimPy `__
* `six `__
* `Solidity `__
* `Sonos Controller (SoCo) `__
* `Sphinx AutoAPI `__
* `sphinx-argparse `__
* `sphinx-tabs `__
* `Sphinx-Gallery `__ (customized)
* `Sphinx with Github Webpages `__
* `SpotBugs `__
* `StarUML `__
* `Sublime Text Unofficial Documentation `__
* `SunPy `__
* `Sylius `__
* `Syncthing `__
* `Tango Controls `__ (customized)
* `ThreatConnect `__
* `TrueNAS `__ (customized)
* `Tuleap `__
* `TYPO3 `__ (customized)
* `Veyon `__
* `Ubiquity `__
* `uWSGI `__
* `virtualenv `__
* `Wagtail `__
* `Web Application Attack and Audit Framework (w3af) `__
* `Weblate `__
* `x265 `__
* `Zeek `__
* `Zulip `__
Documentation using Sphinx Bootstrap Theme
------------------------------------------
`Sphinx Bootstrap Theme documentation `__
* `Bootstrap Theme `__
* `C/C++ Software Development with Eclipse `__
* `Dataverse `__
* `e-cidadania `__
* `Hangfire `__
* `Hedge `__
* `ObsPy `__
* `OPNFV `__
* `Pootle `__
* `PyUblas `__
* `seaborn `__
Documentation using PyData Sphinx Theme
---------------------------------------
`Pydata Sphinx Theme documentation `__
* `Arviz `__
* `Astropy `__
* `Binder `__
* `Bokeh `__
* `CuPy `__
* `EnOSlib `__
* `Fairlearn `__
* `Feature-engine `__
* `Jupyter `__
* `Jupyter Book `__
* `Matplotlib `__
* `MegEngine `__
* `MNE-Python `__
* `NetworkX `__
* `Numpy `__
* `Pandas `__
* `PhaseFieldX `__
* `Pystra (continuation of PyRe) `__
* `PyVista `__
* `SciPy `__
* `Seaborn `__
* `SEPAL `__
Documentation using Furo theme
------------------------------
`Furo theme documentation `__
* `Furo theme `__
* `pytest `__
* `Python Packaging User Guide `__
* `Python Developer's Guide `__
Documentation using a custom theme or integrated in a website
-------------------------------------------------------------
* `AIOHTTP `__
* `Apache Cassandra `__
* `Boto 3 `__
* `CakePHP `__
* `Ceph `__
* `Chef `__
* `CKAN `__
* `Confluent Platform `__
* `Django `__
* `django CMS `__
* `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 `__
* `ObjectListView `__
* `OpenERP `__
* `OpenCV `__
* `Open Dylan `__
* `OpenTURNS `__
* `Open vSwitch `__
* `PlatformIO `__
* `Psycopg `__
* `PyEphem `__
* `Pygments `__
* `Plone User Manual (German) `__
* `PSI4 `__
* `PyMOTW `__
* `python-aspectlib `__ (`sphinx_py3doc_enhanced_theme `__)
* `QGIS `__
* `Roundup `__
* `SaltStack `__
* `scikit-learn `__
* `Scrapy `__
* `Selenium `__
* `Self `__
* `Substance D `__
* `Sulu `__
* `SQLAlchemy `__
* `tinyTiM `__
* `Twisted `__
* `Ubuntu Packaging Guide `__
* `WTForms `__
Homepages and other non-documentation sites
-------------------------------------------
* `Alan Crosswell's Using the Django REST Framework and DRF-JSONAPI `__
* `Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio-and Nanophysics `__ (classic)
* `Benoit Boissinot `__ (classic, customized)
* `EBI Cloud Consultancy Team `__ (sphinx_rtd_theme)
* `Eric Holscher `__ (alabaster)
* `Florian Diesch `__
* `Institute for the Design of Advanced Energy Systems (IDAES) `__ (sphinx_rtd_theme)
* `IDAES Examples `__ (sphinx_rtd_theme)
* `Lei Ma's Statistical Mechanics lecture notes `__ (sphinx_bootstrap_theme)
* `PyXLL `__ (sphinx_bootstrap_theme, customized)
* `SciPy Cookbook `__ (sphinx_rtd_theme)
* `Tech writer at work blog `__ (custom theme)
* `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
----------------------------
* `"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.