2008-06-23 07:35:22 -05:00
Projects using Sphinx
=====================
2024-10-08 17:07:45 -05:00
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 <https://github.com/sphinx-doc/sphinx/>`_.
2008-06-23 07:35:22 -05:00
2010-01-08 11:09:16 -06:00
I've grouped the list into sections to make it easier to find
interesting examples.
2016-03-06 00:31:19 -06:00
Documentation using the alabaster theme
---------------------------------------
2018-08-27 15:31:51 -05:00
* `Alabaster <https://alabaster.readthedocs.io/> `__
2023-07-24 05:49:44 -05:00
* `Blinker <https://blinker.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Calibre <https://manual.calibre-ebook.com/> `__
2021-08-12 02:45:32 -05:00
* `CherryPy <https://cherrypy.readthedocs.io/> `__
2020-03-24 17:36:12 -05:00
* `Click <https://click.palletsprojects.com/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `coala <https://docs.coala.io/> `__ (customized)
* `CodePy <https://documen.tician.de/codepy/> `__
2021-08-12 02:45:32 -05:00
* `Django Q <https://django-q.readthedocs.io/> `__
2019-02-06 14:55:25 -06:00
* `Eve <https://docs.python-eve.org/> `__ (Python REST API framework)
2018-09-23 11:36:25 -05:00
* `Fabric <https://docs.fabfile.org/> `__
* `Fityk <https://fityk.nieto.pl/> `__
2020-03-24 17:36:12 -05:00
* `Flask <https://flask.palletsprojects.com/> `__
2018-08-27 15:31:51 -05:00
* `Flask-OpenID <https://pythonhosted.org/Flask-OpenID/> `__
2018-09-23 11:36:25 -05:00
* `Invoke <https://docs.pyinvoke.org/> `__
2020-03-24 17:36:12 -05:00
* `Jinja <https://jinja.palletsprojects.com/> `__
2021-05-16 09:08:53 -05:00
* `Lino <https://www.lino-framework.org/> `__ (customized)
2024-05-05 12:07:32 -05:00
* `Linux kernel <https://www.kernel.org/doc/html/latest/index.html> `__ (customized)
2018-08-27 15:31:51 -05:00
* `marbl <https://getmarbl.readthedocs.io/> `__
* `MeshPy <https://documen.tician.de/meshpy/> `__
2018-10-16 11:06:59 -05:00
* `Molecule <https://molecule.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `Momotor LTI <https://momotor.org/doc/lti/canvas/> `__
* `Podman <https://docs.podman.io/> `__
2018-08-27 15:31:51 -05:00
* `PyCUDA <https://documen.tician.de/pycuda/> `__
* `PyOpenCL <https://documen.tician.de/pyopencl/> `__
2021-05-16 09:08:53 -05:00
* `PyLangAcq <https://pylangacq.org/> `__
2021-08-12 02:45:32 -05:00
* `python-apt <https://apt-team.pages.debian.net/python-apt/> `__
2018-08-27 15:31:51 -05:00
* `PyVisfile <https://documen.tician.de/pyvisfile/> `__
2022-05-28 09:04:55 -05:00
* `Requests <https://requests.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `searx <https://asciimoo.github.io/searx/> `__
* `Spyder <https://docs.spyder-ide.org/> `__ (customized)
* `Tablib <http://docs.python-tablib.org/> `__
* `urllib3 <https://urllib3.readthedocs.io/> `__ (customized)
2020-03-24 17:36:12 -05:00
* `Werkzeug <https://werkzeug.palletsprojects.com/> `__
2021-08-12 02:45:32 -05:00
* `Write the Docs <https://www.writethedocs.org/> `__
2016-03-06 00:31:19 -06:00
Documentation using the classic theme
2010-01-08 11:09:16 -06:00
-------------------------------------
2021-05-16 09:08:53 -05:00
* `Advanced Generic Widgets <https://xoomer.virgilio.it/infinity77/AGW_Docs/> `__ (customized)
* `Apache CouchDB <https://docs.couchdb.org/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `APSW <https://rogerbinns.github.io/apsw/> `__
2021-05-16 09:08:53 -05:00
* `Arb <https://arblib.org/> `__
2018-08-27 15:31:51 -05:00
* `Beautiful Soup <https://www.crummy.com/software/BeautifulSoup/bs4/doc/> `__
2019-06-09 16:07:22 -05:00
* `Blender API <https://docs.blender.org/api/current/> `__
2018-08-27 15:31:51 -05:00
* `Bugzilla <https://bugzilla.readthedocs.io/> `__
* `Buildbot <https://docs.buildbot.net/latest/> `__
* `CMake <https://cmake.org/documentation/> `__ (customized)
2018-09-23 11:36:25 -05:00
* `Chaco <https://docs.enthought.com/chaco/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `DEAP <https://deap.readthedocs.io/> `__ (customized)
* `Director <https://pythonhosted.org/director/> `__
2024-01-13 22:18:57 -06:00
* `EZ-Draw <https://pageperso.lis-lab.fr/~edouard.thiel/ez-draw/doc/en/html/ez-manual.html> `__ (customized)
2024-06-27 16:32:50 -05:00
* `Generic Mapping Tools (GMT) <https://docs.generic-mapping-tools.org/latest/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Genomedata <https://noble.gs.washington.edu/proj/genomedata/doc/1.3.3/> `__
2024-02-13 04:14:01 -06:00
* `GetFEM <https://getfem.org/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Glasgow Haskell Compiler <https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/> `__ (customized)
2024-01-13 22:18:57 -06:00
* `Grok <https://web.archive.org/web/20230708190705/http://grok.zope.org/doc/current/> `__ (customized)
2021-05-16 09:08:53 -05:00
* `GROMACS <https://manual.gromacs.org/documentation/> `__
2018-09-23 11:36:25 -05:00
* `GSL Shell <https://www.nongnu.org/gsl-shell/> `__
2024-03-25 05:39:05 -05:00
* `Hands-on Python Tutorial <http://anh.cs.luc.edu:80/python/hands-on/3.1/handsonHtml/> `__
2021-08-12 02:45:32 -05:00
* `Kaa <https://freevo.github.io/kaa-base/> `__ (customized)
2024-06-27 16:32:50 -05:00
* `Leo <https://leo-editor.github.io/leo-editor/> `__ (customized)
2018-09-23 11:36:25 -05:00
* `Mayavi <https://docs.enthought.com/mayavi/mayavi/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `MediaGoblin <https://mediagoblin.readthedocs.io/> `__ (customized)
2021-05-16 09:08:53 -05:00
* `mpmath <https://mpmath.org/doc/current/> `__
2018-09-23 11:36:25 -05:00
* `OpenCV <https://docs.opencv.org/> `__ (customized)
2021-05-16 09:08:53 -05:00
* `OpenEXR <https://excamera.com/articles/26/doc/index.html> `__
2024-01-13 22:18:57 -06:00
* `OpenGDA <https://alfred.diamond.ac.uk/documentation/> `__
2021-08-12 02:45:32 -05:00
* `phpDocumentor <https://docs.phpdoc.org/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Plone <https://docs.plone.org/> `__ (customized)
* `PyEMD <https://pyemd.readthedocs.io/> `__
2024-01-13 22:18:57 -06:00
* `Pyevolve <https://pyevolve.sourceforge.net/> `__
2018-08-27 15:31:51 -05:00
* `Pygame <https://www.pygame.org/docs/> `__ (customized)
2021-08-12 02:45:32 -05:00
* `PyMQI <https://dsuch.github.io/pymqi/> `__
2024-01-13 22:18:57 -06:00
* `PyQt4 <https://pyqt.sourceforge.net/Docs/PyQt4/> `__ (customized)
* `PyQt5 <https://pyqt.sourceforge.net/Docs/PyQt5/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Python 2 <https://docs.python.org/2/> `__
* `Python 3 <https://docs.python.org/3/> `__ (customized)
* `Python Packaging Authority <https://www.pypa.io/> `__ (customized)
2024-06-27 16:32:50 -05:00
* `Ring programming language <https://ring-lang.github.io/doc1.20/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `SageMath <https://doc.sagemath.org/> `__ (customized)
2018-09-23 11:36:25 -05:00
* `Segway <https://noble.gs.washington.edu/proj/segway/doc/1.1.0/segway.html> `__
2024-06-27 16:32:50 -05:00
* `simuPOP <https://bopeng.github.io/simuPOP/> `__ (customized)
2018-09-23 11:36:25 -05:00
* `SymPy <https://docs.sympy.org/> `__
2018-08-27 15:31:51 -05:00
* `TurboGears <https://turbogears.readthedocs.io/> `__ (customized)
2018-09-23 11:36:25 -05:00
* `tvtk <https://docs.enthought.com/mayavi/tvtk/> `__
2018-08-27 15:31:51 -05:00
* `Varnish <https://www.varnish-cache.org/docs/> `__ (customized, alabaster for index)
* `Waf <https://waf.io/apidocs/> `__
2018-10-16 11:06:59 -05:00
* `wxPython Phoenix <https://wxpython.org/Phoenix/docs/html/main.html> `__ (customized)
2018-09-23 11:36:25 -05:00
* `z3c <https://www.ibiblio.org/paulcarduner/z3ctutorial/> `__
2018-08-27 15:31:51 -05:00
* `zc.async <https://pythonhosted.org/zc.async/> `__ (customized)
2024-01-13 22:18:57 -06:00
* `Zope <https://www.zope.dev/> `__ (customized)
2010-01-08 11:09:16 -06:00
Documentation using the sphinxdoc theme
---------------------------------------
2019-02-02 15:20:56 -06:00
* `ABRT <https://abrt.readthedocs.io/> `__
2018-09-23 11:36:25 -05:00
* `cartopy <https://scitools.org.uk/cartopy/docs/latest/> `__
2023-07-24 05:49:44 -05:00
* `Jython <https://jython.readthedocs.io/> `__
2019-06-09 16:07:22 -05:00
* `LLVM <https://llvm.org/docs/> `__
2021-05-16 09:08:53 -05:00
* `PyCantonese <https://pycantonese.org/> `__
2021-08-12 02:45:32 -05:00
* `Pyre <https://pyre.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `pySPACE <https://pyspace.github.io/pyspace/> `__
2024-01-13 22:18:57 -06:00
* `Pysparse <https://pysparse.sourceforge.net/> `__
2024-03-25 05:39:05 -05:00
* `PyTango <https://pytango.readthedocs.io> `__
2018-08-27 15:31:51 -05:00
* `Python Wild Magic <https://vmlaker.github.io/pythonwildmagic/> `__ (customized)
2019-06-09 16:07:22 -05:00
* `RDKit <https://www.rdkit.org/docs/> `__
2024-01-13 22:18:57 -06:00
* `Reteisi <https://www.reteisi.org/contents.html> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Turbulenz <http://docs.turbulenz.com/> `__
2010-01-08 11:09:16 -06:00
2017-07-13 18:46:09 -05:00
Documentation using the nature theme
------------------------------------
2020-03-24 17:36:12 -05:00
* `Alembic <https://alembic.sqlalchemy.org/> `__
2021-05-16 09:08:53 -05:00
* `Cython <https://docs.cython.org/> `__
2018-08-27 15:31:51 -05:00
* `easybuild <https://easybuild.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `libLAS <https://liblas.org/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Lmod <https://lmod.readthedocs.io/> `__
2018-09-23 11:36:25 -05:00
* `MapServer <https://mapserver.org/> `__ (customized)
2020-03-24 17:36:12 -05:00
* `PyWavelets <https://pywavelets.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Setuptools <https://setuptools.readthedocs.io/> `__
* `Spring Python <https://docs.spring.io/spring-python/1.2.x/sphinx/html/> `__
2018-09-23 11:36:25 -05:00
* `StatsModels <https://www.statsmodels.org/> `__ (customized)
2024-01-13 22:18:57 -06:00
* `Sylli <https://sylli.sourceforge.net/> `__
2010-01-08 11:09:16 -06:00
Documentation using another builtin theme
-----------------------------------------
2018-08-27 15:31:51 -05:00
* `Breathe <https://breathe.readthedocs.io/> `__ (haiku)
2023-07-24 05:49:44 -05:00
* `Breezy (fork of Bazaar) <https://www.breezy-vcs.org/doc/en/> `__ (agogo)
2018-08-27 15:31:51 -05:00
* `MPipe <https://vmlaker.github.io/mpipe/> `__ (sphinx13)
2018-09-23 11:36:25 -05:00
* `NLTK <https://www.nltk.org/> `__ (agogo)
2018-08-27 15:31:51 -05:00
* `PyPubSub <https://pypubsub.readthedocs.io/> `__ (bizstyle)
2018-09-23 11:36:25 -05:00
* `Pylons <https://docs.pylonsproject.org/projects/pylons-webframework/> `__ (pyramid)
2018-08-27 15:31:51 -05:00
* `Pyramid web framework <https://docs.pylonsproject.org/projects/pyramid/> `__ (pyramid)
2023-07-24 05:49:44 -05:00
* `RxDock <https://rxdock.gitlab.io/documentation/devel/html/> `__ (bizstyle)
2021-05-16 09:08:53 -05:00
* `Sphinx <https://www.sphinx-doc.org/> `__ (sphinx13) :-)
2018-09-23 11:36:25 -05:00
* `Valence <https://docs.valence.desire2learn.com/> `__ (haiku, customized)
2010-01-08 11:09:16 -06:00
2024-10-08 17:07:45 -05:00
Documentation using Read the Docs Sphinx Theme
----------------------------------------------
`Read the Docs Sphinx Theme documentation <https://sphinx-rtd-theme.readthedocs.io/> `__
2017-07-13 18:46:09 -05:00
2023-07-24 05:49:44 -05:00
* `Aesara (fork of Theano) <https://aesara.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Annotator <https://docs.annotatorjs.org/> `__
2018-08-27 15:31:51 -05:00
* `Ansible <https://docs.ansible.com/> `__ (customized)
2021-05-16 09:08:53 -05:00
* `Arcade <https://arcade.academy/> `__
2018-08-27 15:31:51 -05:00
* `aria2 <https://aria2.github.io/manual/en/html/> `__
* `ASE <https://wiki.fysik.dtu.dk/ase/> `__
2021-06-01 06:21:36 -05:00
* `asvin <https://asvin.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Autofac <https://docs.autofac.org/> `__
2018-08-27 15:31:51 -05:00
* `BigchainDB <https://docs.bigchaindb.com/> `__
2019-06-09 16:07:22 -05:00
* `Blender Reference Manual <https://docs.blender.org/manual/> `__
2018-08-27 15:31:51 -05:00
* `Blocks <https://blocks.readthedocs.io/> `__
* `bootstrap-datepicker <https://bootstrap-datepicker.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `Certbot <https://certbot.eff.org/docs/> `__
* `CKAN <https://docs.ckan.org/> `__
* `Copr Buildsystem <https://docs.pagure.org/copr.copr/> `__ (customized)
* `Coreboot <https://doc.coreboot.org/> `__
2018-08-27 15:31:51 -05:00
* `Chainer <https://docs.chainer.org/> `__ (customized)
2021-08-12 02:45:32 -05:00
* `citeproc-js <https://citeproc-js.readthedocs.io/> `__
2018-10-16 11:06:59 -05:00
* `cloud-init <https://cloudinit.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `CodeIgniter <https://www.codeigniter.com/user_guide/> `__
* `Conda <https://conda.io/docs/> `__
* `Corda <https://docs.corda.net/> `__
* `Dask <https://dask.pydata.org/> `__
* `Databricks <https://docs.databricks.com/> `__ (customized)
* `Dataiku DSS <https://doc.dataiku.com/> `__
2018-10-16 11:06:59 -05:00
* `DNF <https://dnf.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `Distro Tracker <https://qa.pages.debian.net/distro-tracker/> `__
2020-01-28 12:53:42 -06:00
* `Django-cas-ng <https://djangocas.dev/docs/> `__
2024-06-27 16:32:50 -05:00
* `dj-stripe <https://dj-stripe.github.io/dj-stripe/> `__
2018-09-23 11:36:25 -05:00
* `edX <https://docs.edx.org/> `__
2021-05-16 09:08:53 -05:00
* `Electrum <https://docs.electrum.org/> `__
2018-08-27 15:31:51 -05:00
* `ESWP3 <https://eswp3.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Ethereum Homestead <https://www.ethdocs.org/> `__
2019-06-09 16:07:22 -05:00
* `Exhale <https://exhale.readthedocs.io/> `__
2019-02-02 15:20:56 -06:00
* `Faker <https://faker.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Fidimag <https://fidimag.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Flake8 <https://flake8.pycqa.org/> `__
* `Flatpak <https://docs.flatpak.org/> `__
2018-10-16 11:06:59 -05:00
* `FluidDyn <https://fluiddyn.readthedocs.io/> `__
* `Fluidsim <https://fluidsim.readthedocs.io/> `__
2019-06-09 16:07:22 -05:00
* `Gallium <https://gallium.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `GeoNode <https://docs.geonode.org/> `__
2019-02-02 15:20:56 -06:00
* `Glances <https://glances.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Godot <https://godot.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Graylog <https://docs.graylog.org/> `__
2018-08-27 15:31:51 -05:00
* `GPAW <https://wiki.fysik.dtu.dk/gpaw/> `__ (customized)
2021-05-16 09:08:53 -05:00
* `HDF5 for Python (h5py) <https://docs.h5py.org/> `__
2021-08-12 02:45:32 -05:00
* `HyperKitty <https://hyperkitty.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Hyperledger Fabric <https://hyperledger-fabric.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `IdentityServer <https://docs.identityserver.io/> `__
* `Idris <https://docs.idris-lang.org/> `__
2021-08-12 02:45:32 -05:00
* `Inkscape <https://inkscape-manuals.readthedocs.io/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `javasphinx <https://bronto-javasphinx.readthedocs.io/> `__
* `Jupyter Notebook <https://jupyter-notebook.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `Kanboard <https://docs.kanboard.org/> `__
2018-08-27 15:31:51 -05:00
* `Lasagne <https://lasagne.readthedocs.io/> `__
* `latexindent.pl <https://latexindentpl.readthedocs.io/> `__
2019-03-28 23:17:32 -05:00
* `Learning Apache Spark with Python <https://runawayhorse001.github.io/LearningApacheSpark> `__
2020-04-07 13:04:43 -05:00
* `LibCEED <https://libceed.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Linguistica <https://linguistica-uchicago.github.io/lxa5/> `__
2021-05-16 09:08:53 -05:00
* `Mailman <https://docs.list.org/> `__
2018-08-27 15:31:51 -05:00
* `MathJax <https://docs.mathjax.org/> `__
2024-01-13 22:18:57 -06:00
* `MDTraj <https://mdtraj.org/> `__ (customized)
2020-07-07 15:10:54 -05:00
* `Mesa 3D <https://docs.mesa3d.org/> `__
2019-06-09 16:07:22 -05:00
* `micca - MICrobial Community Analysis <https://micca.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `MicroPython <https://docs.micropython.org/> `__
2021-05-16 09:08:53 -05:00
* `Mink <https://mink.behat.org/> `__
* `Mockery <https://docs.mockery.io/> `__
2018-08-27 15:31:51 -05:00
* `mod_wsgi <https://modwsgi.readthedocs.io/> `__
* `MoinMoin <https://moin-20.readthedocs.io/> `__
* `Mopidy <https://docs.mopidy.com/> `__
2020-03-24 17:36:12 -05:00
* `mpi4py <https://mpi4py.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `MyHDL <https://docs.myhdl.org/> `__
2021-08-12 02:45:32 -05:00
* `Mypy <https://mypy.readthedocs.io/> `__
* `Netgate Docs <https://docs.netgate.com/> `__
* `Nextcloud Server <https://docs.nextcloud.com/#server> `__
2018-08-27 15:31:51 -05:00
* `Nextflow <https://www.nextflow.io/docs/latest/index.html> `__
2021-08-12 02:45:32 -05:00
* `nghttp2 <https://nghttp2.org/documentation/> `__
2018-08-27 15:31:51 -05:00
* `NICOS <https://forge.frm2.tum.de/nicos/doc/nicos-master/> `__ (customized)
2022-01-16 13:16:34 -06:00
* `OpenFAST <https://openfast.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `Panda3D <https://docs.panda3d.org/> `__ (customized)
2021-05-16 09:08:53 -05:00
* `Pelican <https://docs.getpelican.com/> `__
2018-08-27 15:31:51 -05:00
* `picamera <https://picamera.readthedocs.io/> `__
* `Pillow <https://pillow.readthedocs.io/> `__
* `pip <https://pip.pypa.io/> `__
* `Paver <https://paver.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `peewee <https://docs.peewee-orm.com/> `__
* `Phinx <https://docs.phinx.org/> `__
2018-08-27 15:31:51 -05:00
* `phpMyAdmin <https://docs.phpmyadmin.net/> `__
2021-08-12 02:45:32 -05:00
* `PHPUnit <https://phpunit.readthedocs.io/> `__
* `PHPWord <https://phpword.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `PROS <https://pros.cs.purdue.edu/v5/> `__ (customized)
2021-05-16 09:08:53 -05:00
* `Pweave <https://mpastell.com/pweave/> `__
2021-08-12 02:45:32 -05:00
* `pyca/cryptograhpy <https://cryptography.io/> `__
2024-02-06 02:37:01 -06:00
* `pyglet <https://pyglet.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `PyNaCl <https://pynacl.readthedocs.io/> `__
* `pyOpenSSL <https://www.pyopenssl.org/> `__
2021-05-16 09:08:53 -05:00
* `PyPy <https://doc.pypy.org/> `__
2018-08-27 15:31:51 -05:00
* `python-sqlparse <https://sqlparse.readthedocs.io/> `__
* `PyVISA <https://pyvisa.readthedocs.io/> `__
* `Read The Docs <https://docs.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `RenderDoc <https://renderdoc.org/docs/> `__
* `ROCm Platform <https://rocmdocs.amd.com/> `__
2021-05-16 09:08:53 -05:00
* `Free your information from their silos (French) <https://redaction-technique.org/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Releases Sphinx extension <https://releases.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Qtile <https://docs.qtile.org/> `__
2024-01-13 22:18:57 -06:00
* `Quex <https://quex.sourceforge.net/doc/html/main.html> `__
2024-06-27 16:32:50 -05:00
* `QuTiP <https://qutip.readthedocs.io/en/latest/> `__
2024-03-25 05:39:05 -05:00
* `Sawtooth <https://sawtooth.splinter.dev/docs> `__
2018-08-27 15:31:51 -05:00
* `Scapy <https://scapy.readthedocs.io/> `__
2020-03-24 17:36:12 -05:00
* `SimGrid <https://simgrid.org/doc/latest/> `__
2018-09-23 11:36:25 -05:00
* `SimPy <https://simpy.readthedocs.io/> `__
2018-10-16 11:06:59 -05:00
* `six <https://six.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Solidity <https://solidity.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Sonos Controller (SoCo) <https://docs.python-soco.com/> `__
2018-08-27 15:31:51 -05:00
* `Sphinx AutoAPI <https://sphinx-autoapi.readthedocs.io/> `__
* `sphinx-argparse <https://sphinx-argparse.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `sphinx-tabs <https://sphinx-tabs.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `Sphinx-Gallery <https://sphinx-gallery.readthedocs.io/> `__ (customized)
2019-03-29 11:32:42 -05:00
* `Sphinx with Github Webpages <https://runawayhorse001.github.io/SphinxGithub> `__
2018-08-27 15:31:51 -05:00
* `SpotBugs <https://spotbugs.readthedocs.io/> `__
2018-09-23 11:36:25 -05:00
* `StarUML <https://docs.staruml.io/> `__
2024-01-13 22:18:57 -06:00
* `Sublime Text Unofficial Documentation <https://docs.sublimetext.info/> `__
2018-09-23 11:36:25 -05:00
* `SunPy <https://docs.sunpy.org/> `__
2023-07-24 05:49:44 -05:00
* `Sylius <https://docs.sylius.com/> `__
2019-02-02 15:20:56 -06:00
* `Syncthing <https://docs.syncthing.net/> `__
2018-08-27 15:31:51 -05:00
* `Tango Controls <https://tango-controls.readthedocs.io/> `__ (customized)
* `ThreatConnect <https://docs.threatconnect.com/> `__
2021-08-12 02:45:32 -05:00
* `TrueNAS <https://www.ixsystems.com/documentation/truenas/> `__ (customized)
2018-08-27 15:31:51 -05:00
* `Tuleap <https://tuleap.net/doc/en/> `__
* `TYPO3 <https://docs.typo3.org/> `__ (customized)
2019-02-02 15:20:56 -06:00
* `Veyon <https://docs.veyon.io/> `__
2021-08-12 02:45:32 -05:00
* `Ubiquity <https://micro-framework.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `uWSGI <https://uwsgi-docs.readthedocs.io/> `__
2018-10-16 11:06:59 -05:00
* `virtualenv <https://virtualenv.readthedocs.io/> `__
2018-09-23 11:36:25 -05:00
* `Wagtail <https://docs.wagtail.io/> `__
2021-05-16 09:08:53 -05:00
* `Web Application Attack and Audit Framework (w3af) <https://docs.w3af.org/> `__
2018-08-27 15:31:51 -05:00
* `Weblate <https://docs.weblate.org/> `__
* `x265 <https://x265.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `Zeek <https://docs.zeek.org/> `__
2019-02-02 15:20:56 -06:00
* `Zulip <https://zulip.readthedocs.io/> `__
2017-07-13 18:46:09 -05:00
2024-10-08 17:07:45 -05:00
Documentation using Sphinx Bootstrap Theme
2017-07-13 18:46:09 -05:00
------------------------------------------
2024-10-08 17:07:45 -05:00
`Sphinx Bootstrap Theme documentation <https://ryan-roemer.github.io/sphinx-bootstrap-theme/> `__
2018-08-27 15:31:51 -05:00
* `Bootstrap Theme <https://ryan-roemer.github.io/sphinx-bootstrap-theme/> `__
2018-09-23 11:36:25 -05:00
* `C/C++ Software Development with Eclipse <https://eclipsebook.in/> `__
2021-05-16 09:08:53 -05:00
* `Dataverse <https://guides.dataverse.org/> `__
2018-08-27 15:31:51 -05:00
* `e-cidadania <https://e-cidadania.readthedocs.io/> `__
2021-05-16 09:08:53 -05:00
* `Hangfire <https://docs.hangfire.io/> `__
2018-08-27 15:31:51 -05:00
* `Hedge <https://documen.tician.de/hedge/> `__
* `ObsPy <https://docs.obspy.org/> `__
2019-06-09 16:07:22 -05:00
* `OPNFV <https://docs.opnfv.org/> `__
2021-05-16 09:08:53 -05:00
* `Pootle <https://docs.translatehouse.org/projects/pootle/> `__
2018-08-27 15:31:51 -05:00
* `PyUblas <https://documen.tician.de/pyublas/> `__
* `seaborn <https://seaborn.pydata.org/> `__
2010-01-08 11:09:16 -06:00
2024-10-08 17:07:45 -05:00
Documentation using PyData Sphinx Theme
2022-12-29 07:59:34 -06:00
---------------------------------------
2024-10-08 17:07:45 -05:00
`Pydata Sphinx Theme documentation <https://pydata-sphinx-theme.readthedocs.io/> `__
2022-12-29 07:59:34 -06:00
* `Arviz <https://python.arviz.org/en/stable/> `__
2024-10-08 17:07:45 -05:00
* `Astropy <https://docs.astropy.org/> `__
2022-12-29 07:59:34 -06:00
* `Binder <https://mybinder.readthedocs.io/en/latest/> `__
* `Bokeh <https://docs.bokeh.org/en/latest/> `__
* `CuPy <https://docs.cupy.dev/en/stable/> `__
* `EnOSlib <https://discovery.gitlabpages.inria.fr/enoslib/> `__
* `Fairlearn <https://fairlearn.org/main/> `__
* `Feature-engine <https://feature-engine.readthedocs.io/en/latest/> `__
* `Jupyter <https://docs.jupyter.org/en/latest/> `__
* `Jupyter Book <https://jupyterbook.org/en/stable/intro.html> `__
* `Matplotlib <https://matplotlib.org/stable/index.html> `__
* `MegEngine <https://megengine.org.cn/doc/stable/en/> `__
* `MNE-Python <https://mne.tools/stable/> `__
* `NetworkX <https://networkx.org/documentation/stable/> `__
* `Numpy <https://numpy.org/doc/stable/> `__
* `Pandas <https://pandas.pydata.org/docs/> `__
2024-09-17 21:02:47 -05:00
* `PhaseFieldX <https://phasefieldx.readthedocs.io/> `__
2023-07-24 05:49:44 -05:00
* `Pystra (continuation of PyRe) <https://pystra.github.io/pystra/> `__
2022-12-29 07:59:34 -06:00
* `PyVista <https://docs.pyvista.org/> `__
* `SciPy <https://docs.scipy.org/doc/scipy/> `__
2024-10-08 17:07:45 -05:00
* `Seaborn <https://seaborn.pydata.org/> `__
2022-12-29 07:59:34 -06:00
* `SEPAL <https://docs.sepal.io/en/latest/index.html> `__
2024-10-08 17:07:45 -05:00
Documentation using Furo theme
------------------------------
`Furo theme documentation <https://pradyunsg.me/furo/> `__
* `Furo theme <https://pradyunsg.me/furo/> `__
* `pytest <https://docs.pytest.org/> `__
* `Python Packaging User Guide <https://packaging.python.org/> `__
* `Python Developer's Guide <https://devguide.python.org/> `__
2017-07-13 18:46:09 -05:00
Documentation using a custom theme or integrated in a website
-------------------------------------------------------------
2010-01-08 11:09:16 -06:00
2021-04-29 16:50:25 -05:00
* `AIOHTTP <https://docs.aiohttp.org/> `__
2018-08-27 15:31:51 -05:00
* `Apache Cassandra <https://cassandra.apache.org/doc/> `__
* `Boto 3 <https://boto3.readthedocs.io/> `__
* `CakePHP <https://book.cakephp.org/> `__
2021-05-16 09:08:53 -05:00
* `Ceph <https://docs.ceph.com/docs/master/> `__
2018-08-27 15:31:51 -05:00
* `Chef <https://docs.chef.io/> `__
2018-09-23 11:36:25 -05:00
* `CKAN <https://docs.ckan.org/> `__
* `Confluent Platform <https://docs.confluent.io/> `__
2018-08-27 15:31:51 -05:00
* `Django <https://docs.djangoproject.com/> `__
2021-08-12 02:45:32 -05:00
* `django CMS <https://docs.django-cms.org/> `__
2018-09-23 11:36:25 -05:00
* `Doctrine <https://www.doctrine-project.org/> `__
2018-08-27 15:31:51 -05:00
* `Enterprise Toolkit for Acrobat products <https://www.adobe.com/devnet-docs/acrobatetk/> `__
2020-12-28 12:19:46 -06:00
* `FreeFEM <https://doc.freefem.org/introduction/> `__
2020-03-24 17:36:12 -05:00
* `fmt <https://fmt.dev/> `__
2021-05-16 09:08:53 -05:00
* `Gameduino <https://excamera.com/sphinx/gameduino/> `__
2018-08-27 15:31:51 -05:00
* `gensim <https://radimrehurek.com/gensim/> `__
2021-05-16 09:08:53 -05:00
* `GeoServer <https://docs.geoserver.org/> `__
* `gevent <https://www.gevent.org/> `__
2018-09-23 11:36:25 -05:00
* `GHC - Glasgow Haskell Compiler <https://downloads.haskell.org/~ghc/master/users-guide/> `__
2021-05-16 09:08:53 -05:00
* `Guzzle <https://docs.guzzlephp.org/> `__
* `H2O.ai <https://docs.h2o.ai/> `__
2019-02-02 15:20:56 -06:00
* `Heka <https://hekad.readthedocs.io/> `__
2021-08-12 02:45:32 -05:00
* `Istihza (Turkish Python documentation project) <https://python-istihza.yazbel.com/> `__
2020-03-24 17:36:12 -05:00
* `JupyterHub <https://jupyterhub.readthedocs.io/> `__
2023-07-24 05:49:44 -05:00
* `Kombu <https://kombu.readthedocs.io/> `__
* `Lasso <http://www.lassoguide.com/> `__
2021-05-16 09:08:53 -05:00
* `Mako <https://docs.makotemplates.org/> `__
2023-07-24 05:49:44 -05:00
* `MirrorBrain <https://mirrorbrain-docs.readthedocs.io/> `__
2020-09-23 12:53:47 -05:00
* `Mitiq <https://mitiq.readthedocs.io/> `__
2018-08-27 15:31:51 -05:00
* `MongoDB <https://docs.mongodb.com/> `__
2018-09-23 11:36:25 -05:00
* `Music21 <https://web.mit.edu/music21/doc/> `__
2021-05-16 09:08:53 -05:00
* `MyHDL <https://docs.myhdl.org/> `__
2019-06-09 16:07:22 -05:00
* `ndnSIM <https://ndnsim.net/current/> `__
2018-08-27 15:31:51 -05:00
* `nose <https://nose.readthedocs.io/> `__
* `ns-3 <https://www.nsnam.org/documentation/> `__
2024-01-13 22:18:57 -06:00
* `ObjectListView <https://objectlistview.sourceforge.net/python/> `__
2018-08-27 15:31:51 -05:00
* `OpenERP <https://doc.odoo.com/> `__
2018-09-23 11:36:25 -05:00
* `OpenCV <https://docs.opencv.org/> `__
2023-07-24 05:49:44 -05:00
* `Open Dylan <https://opendylan.org/> `__
2024-01-13 22:18:57 -06:00
* `OpenTURNS <https://openturns.github.io/openturns/latest/> `__
2021-05-16 09:08:53 -05:00
* `Open vSwitch <https://docs.openvswitch.org/> `__
2018-09-23 11:36:25 -05:00
* `PlatformIO <https://docs.platformio.org/> `__
2021-08-12 02:45:32 -05:00
* `Psycopg <https://www.psycopg.org/docs/> `__
2021-05-16 09:08:53 -05:00
* `PyEphem <https://rhodesmill.org/pyephem/> `__
2021-05-16 07:53:58 -05:00
* `Pygments <https://pygments.org/docs/> `__
2018-08-27 15:31:51 -05:00
* `Plone User Manual (German) <https://www.hasecke.com/plone-benutzerhandbuch/4.0/> `__
2021-05-16 09:08:53 -05:00
* `PSI4 <https://www.psicode.org/psi4manual/master/index.html> `__
2018-08-27 15:31:51 -05:00
* `PyMOTW <https://pymotw.com/2/> `__
* `python-aspectlib <https://python-aspectlib.readthedocs.io/> `__ (`sphinx_py3doc_enhanced_theme <https://pypi.org/project/sphinx_py3doc_enhanced_theme/> `__ )
* `QGIS <https://qgis.org/en/docs/index.html> `__
2021-05-16 09:08:53 -05:00
* `Roundup <https://www.roundup-tracker.org/> `__
2018-08-27 15:31:51 -05:00
* `SaltStack <https://docs.saltstack.com/> `__
2021-05-16 09:08:53 -05:00
* `scikit-learn <https://scikit-learn.org/stable/> `__
2018-08-27 15:31:51 -05:00
* `Scrapy <https://doc.scrapy.org/> `__
2018-09-23 11:36:25 -05:00
* `Selenium <https://docs.seleniumhq.org/docs/> `__
2021-05-16 09:08:53 -05:00
* `Self <https://www.selflanguage.org/> `__
2018-08-27 15:31:51 -05:00
* `Substance D <https://docs.pylonsproject.org/projects/substanced/> `__
2021-05-16 09:08:53 -05:00
* `Sulu <https://docs.sulu.io/> `__
2018-08-27 15:31:51 -05:00
* `SQLAlchemy <https://docs.sqlalchemy.org/> `__
2024-01-13 22:18:57 -06:00
* `tinyTiM <https://tinytim.sourceforge.net/docs/2.0/> `__
2018-09-23 11:36:25 -05:00
* `Twisted <https://twistedmatrix.com/documents/current/> `__
2021-05-16 09:08:53 -05:00
* `Ubuntu Packaging Guide <https://packaging.ubuntu.com/html/> `__
2018-08-27 15:31:51 -05:00
* `WTForms <https://wtforms.readthedocs.io/> `__
2010-01-08 11:09:16 -06:00
Homepages and other non-documentation sites
-------------------------------------------
2024-01-13 22:18:57 -06:00
* `Alan Crosswell's Using the Django REST Framework and DRF-JSONAPI <https://www.columbia.edu/~alan/django-jsonapi-training/> `__
2018-08-27 15:31:51 -05:00
* `Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio-and Nanophysics <https://becksteinlab.physics.asu.edu/pages/courses/2013/SimBioNano/> `__ (classic)
* `Benoit Boissinot <https://bboissin.appspot.com/> `__ (classic, customized)
2021-08-12 02:45:32 -05:00
* `EBI Cloud Consultancy Team <https://tsi-ccdoc.readthedocs.io/> `__ (sphinx_rtd_theme)
2021-05-16 09:08:53 -05:00
* `Eric Holscher <https://ericholscher.com/> `__ (alabaster)
2021-08-12 02:45:32 -05:00
* `Florian Diesch <https://www.florian-diesch.de/> `__
* `Institute for the Design of Advanced Energy Systems (IDAES) <https://idaes-pse.readthedocs.io/> `__ (sphinx_rtd_theme)
* `IDAES Examples <https://idaes.github.io/examples-pse/> `__ (sphinx_rtd_theme)
2023-07-24 05:49:44 -05:00
* `Lei Ma's Statistical Mechanics lecture notes <https://statisticalphysics.leima.is/> `__ (sphinx_bootstrap_theme)
2018-08-27 15:31:51 -05:00
* `PyXLL <https://www.pyxll.com/> `__ (sphinx_bootstrap_theme, customized)
* `SciPy Cookbook <https://scipy-cookbook.readthedocs.io/> `__ (sphinx_rtd_theme)
2023-07-24 05:49:44 -05:00
* `Tech writer at work blog <https://documatt.com/blog/> `__ (custom theme)
2018-08-27 15:31:51 -05:00
* `UC Berkeley ME233 Advanced Control Systems II course <https://berkeley-me233.github.io/> `__ (sphinxdoc)
2023-07-24 05:49:44 -05:00
* `Željko Svedružić's Biomolecular Structure and Function Laboratory (BioSFLab) <https://svedruziclab.github.io/> `__ (sphinx_bootstrap_theme)
2011-01-04 14:51:16 -06:00
Books produced using Sphinx
---------------------------
2018-09-10 09:00:58 -05:00
* `"The Art of Community" (Japanese translation) <https://www.oreilly.co.jp/books/9784873114958/> `__
2018-08-27 15:31:51 -05:00
* `"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/> `__
2018-09-10 09:02:54 -05:00
* `"Expert Python Programming 2nd Edition" (Japanese translation) <https://www.amazon.co.jp/dp/4048930613/> `__
2018-09-23 11:36:25 -05:00
* `"The Hitchhiker's Guide to Python" <https://docs.python-guide.org/> `__
2023-07-24 05:49:44 -05:00
* `"LassoGuide" <http://www.lassoguide.com/> `__
2018-08-27 15:31:51 -05:00
* `"Learning Sphinx" (in Japanese) <https://www.oreilly.co.jp/books/9784873116488/> `__
2018-09-10 09:00:58 -05:00
* `"Learning System Programming with Go (Japanese)" <https://www.lambdanote.com/products/go> `__
2018-08-27 15:31:51 -05:00
* `"Mercurial: the definitive guide (Second edition)" <https://book.mercurial-scm.org/> `__
2018-09-10 09:00:58 -05:00
* `"Mithril -- The fastest clientside MVC (Japanese)" <https://www.oreilly.co.jp/books/9784873117447/> `__
2024-01-13 22:18:57 -06:00
* "Pioneers and Prominent Men of Utah"
2018-08-27 15:31:51 -05:00
* `"Pomodoro Technique Illustrated" (Japanese translation) <https://www.amazon.co.jp/dp/4048689525/> `__
2019-02-02 15:20:56 -06:00
* `"Professional Software Development" <https://mixmastamyk.bitbucket.io/pro_soft_dev/> `__
2021-05-16 09:08:53 -05:00
* `"Python Professional Programming" (in Japanese) <https://www.amazon.co.jp/dp/4798032948/> `__
2018-09-10 09:42:23 -05:00
* `"Python Professional Programming 2nd Edition" (in Japanese) <https://www.amazon.co.jp/dp/479804315X/> `__
* `"Python Professional Programming 3rd Edition" (in Japanese) <https://www.amazon.co.jp/dp/4798053821/> `__
2019-07-10 15:57:39 -05:00
* `Python Course by Yuri Petrov (Russian) <https://www.yuripetrov.ru/edu/python> `__
2018-09-10 09:00:58 -05:00
* `"Real World HTTP -- Learning The Internet and Web Technology via its history and code (Japanese)" <https://www.oreilly.co.jp/books/9784873118048/> `__
2018-08-27 15:31:51 -05:00
* `"Redmine Primer 5th Edition (in Japanese)" <https://www.shuwasystem.co.jp/products/7980html/4825.html> `__
* `"The repoze.bfg Web Application Framework" <https://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379> `__
2018-09-10 09:42:23 -05:00
* `"The Self-Taught Programmer" (Japanese translation) <https://www.amazon.co.jp/dp/4822292274/> `__
2018-08-27 15:31:51 -05:00
* `"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/> `__
2018-09-23 11:36:25 -05:00
* `"Theoretical Physics Reference" <https://www.theoretical-physics.net/> `__
2018-08-27 15:31:51 -05:00
* `"The Varnish Book" <https://info.varnish-software.com/the-varnish-book> `__
2013-07-26 10:40:08 -05:00
2022-01-16 13:16:34 -06:00
Theses produced using Sphinx
2017-07-13 18:46:09 -05:00
----------------------------
2013-07-26 10:40:08 -05:00
2018-08-27 15:31:51 -05:00
* `"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/> `__
2018-08-03 16:43:32 -05:00
Projects integrating Sphinx functionality
-----------------------------------------
2018-08-27 15:31:51 -05:00
* `Read the Docs <https://readthedocs.org/> `__ , a software-as-a-service documentation hosting platform, uses
Sphinx to automatically build documentation updates that are pushed to GitHub.
2018-08-03 16:43:32 -05:00
2021-08-12 02:45:32 -05:00
* `Spyder <https://docs.spyder-ide.org/current/panes/help.html> `__ , the Scientific Python Development
Environment, uses Sphinx in its help pane to render rich documentation for functions, classes and methods
2018-08-27 15:31:51 -05:00
automatically or on-demand.