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