使用 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.

使用 alabaster 主題的文件

• 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

使用 classic 主題的文件

• 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)

使用 sphinxdoc 主題的文件

• ABRT

• cartopy

• Jython

• LLVM

• PyCantonese

• Pyre

• pySPACE

• Pysparse

• PyTango

• Python Wild Magic (customized)

• RDKit

• Reteisi (customized)

• Turbulenz

使用 nature 主題的文件

• Alembic

• Cython

• easybuild

• libLAS (customized)

• Lmod

• MapServer (customized)

• PyWavelets

• Setuptools

• Spring Python

• StatsModels (customized)

• Sylli

使用其他內建主題的文件

• 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)

使用 Read the Docs Sphinx 主題的文件

Read the Docs Sphinx 主題文件

• 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

使用 Sphinx Bootstrap 主題的文件

Sphinx Bootstrap 主題文件

• Bootstrap Theme

• C/C++ Software Development with Eclipse

• Dataverse

• e-cidadania

• Hangfire

• Hedge

• ObsPy

• OPNFV

• Pootle

• PyUblas

• seaborn

使用 PyData Sphinx 主題的文件

Pydata Sphinx 主題文件

• 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

使用 Furo 主題的文件

Furo 主題文件

• Furo theme

• pytest

• Python Packaging User Guide

• Python Developer's Guide

使用自訂主題或整合於網站中的文件

• 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.

Previous

Sphinx 0.1