使用Sphinx的项目

以下列出的项目仅是使用 Sphinx 进行文档构建的部分示例。如果你希望新增项目， create an issue or pull request on GitHub.

为了更容易找到有趣的例子，我将列表分成了几个部分。

使用alabaster主题的文档

• Alabaster

• Blinker

• Calibre

• CheeryPy

• Click (customized)

• coala (customized)

• CodePy

• Django Q

• Eve (Python REST API framework)

• Fabric

• Fityk

• Flask

• Flask-OpenID

• Invoke

• Jinja

• Lino (customized)

• Linux kernel （定制版）

• marbl

• MeshPy

• Molecule

• Momotor LTI

• Podman

• PyCUDA

• PyOpenCL

• PyLangAcq

• python-apt

• PyVisfile

• Requests

• searx

• Spyder (定制的)

• Tablib

• urllib3 (customized)

• Werkzeug

• Write the Docs

使用经典主题的文档

• 高级通用控件 (定制的)

• Apache CouchDB (定制的)

• APSW

• Arb

• Beautiful Soup

• Blender API

• Bugzilla

• Buildbot

• CMake (定制的)

• Chaco (定制的)

• DEAP (customized)

• Director

• EZ-Draw （定制版）

• Generic Mapping Tools (GMT) (定制的)

• Genomedata

• GetFEM (定制的)

• Glasgow Haskell编译器 (定制的)

• Grok (定制的)

• GROMACS

• GSL Shell

• Hands-on Python Tutorial

• Kaa (定制的)

• Leo (定制的)

• Mayavi (定制的)

• MediaGoblin (定制的)

• mpmath

• OpenCV (定制的)

• OpenEXR

• OpenGDA

• phpDocumentor (定制的)

• Plone (定制的)

• PyEMD

• Pyevolve

• Pygame (定制的)

• PyMQI

• PyQt4 (定制的)

• PyQt5 (定制的)

• Python 2

• Python 3 (定制的)

• Python Packaging Authority (定制的)

• Ring programming language (定制的)

• SageMath (定制的)

• Segway

• simuPOP (定制的)

• SymPy

• TurboGears (定制的)

• tvtk

• Varnish (定制的，alabaster索引)

• Waf

• wxPython Phoenix (定制的)

• z3c

• zc.async (定制的)

• Zope (定制的)

使用sphinxdoc主题的文档

• ABRT

• cartopy

• Jython

• LLVM

• PyCantonese

• Pyre

• pySPACE

• Pysparse

• PyTango

• Python Wild Magic (定制的)

• RDKit

• Reteisi (定制的)

• Turbulenz

使用自然主题的文档

• Alembic

• Cython

• easybuild

• libLAS (定制的)

• Lmod

• MapServer (定制的)

• PyWavelets

• Setuptools

• Spring Python

• StatsModels (定制的)

• Sylli

使用另一个内置主题的文档

• Breathe (haiku)

• Breezy (fork of Bazaar) (agogo)

• MPipe (sphinx13)

• NLTK (agogo)

• PyPubSub (安全)

• Pylons (金字塔)

• Pyramid web framework (金字塔)

• RxDock (bizstyle)

• Sphinx (sphinx13) :-)

• Valence (haiku, 定制的)

使用 Read the Docs Sphinx 主题的文档

Read the Docs Sphinx Theme documentation

• Aesara (fork of Theano)

• Annotator

• Ansible (定制的)

• Arcade

• aria2

• ASE

• asvin

• Autofac

• BigchainDB

• Blender Reference Manual

• Blocks

• bootstrap-datepicker

• Certbot

• CKAN

• Copr Buildsystem (定制的)

• Coreboot

• Chainer (定制的)

• citeproc-js

• cloud-init

• CodeIgniter

• Conda

• Corda

• Dask

• Databricks (定制的)

• 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 (定制的)

• HDF5 for Python (h5py)

• HyperKitty

• Hyperledger Fabric

• IdentityServer

• Idris

• Inkscape (定制的)

• javasphinx

• Jupyter Notebook

• Kanboard

• Lasagne

• latexindent.pl

• Learning Apache Spark with Python

• LibCEED

• Linguistica

• Mailman

• MathJax

• MDTraj (定制的)

• Mesa 3D

• micca - MICrobial社区分析

• MicroPython

• Mink

• Mockery

• mod_wsgi

• MoinMoin

• Mopidy

• mpi4py

• MyHDL

• Mypy

• Netgate Docs

• Nextcloud Server

• Nextflow

• nghttp2

• NICOS (定制的)

• OpenFAST

• Panda3D (定制的)

• Pelican

• picamera

• Pillow

• pip

• Paver

• peewee

• Phinx

• phpMyAdmin

• PHPUnit

• PHPWord

• PROS (定制的)

• Pweave

• pyca/cryptograhpy

• pyglet

• PyNaCl

• pyOpenSSL

• PyPy

• python-sqlparse

• PyVISA

• Read The Docs

• RenderDoc

• ROCm Platform

• 从它们的孤岛中解放你的信息（法语） (定制的)

• Releases Sphinx extension

• Qtile

• Quex

• QuTiP

• Sawtooth

• Scapy

• SimGrid

• SimPy

• six

• Solidity

• Sonos Controller (SoCo)

• Sphinx AutoAPI

• sphinx-解析

• sphinx-tabs

• Sphinx-Gallery (定制的)

• Sphinx的github网页

• SpotBugs

• StarUML

• Sublime Text非官方文档

• SunPy

• Sylius

• Syncthing

• Tango Controls (定制的)

• ThreatConnect

• TrueNAS (定制的)

• Tuleap

• TYPO3 (定制的)

• Veyon

• Ubiquity

• uWSGI

• virtualenv

• Wagtail

• Web应用攻击与审计框架 (w3af)

• Weblate

• x265

• Zeek

• Zulip

使用 Sphinx Bootstrap 主题的文档

Sphinx Bootstrap 主题文档

• 引导主题

• 用Eclipse的C/C++软件发展

• Dataverse

• e-cidadania

• Hangfire

• Hedge

• ObsPy

• OPNFV

• Pootle

• PyUblas

• seaborn

使用 PyData Sphinx 主题的文档

Pydata Sphinx 主题文档

• Arviz

• Astropy

• Binder

• Bokeh

• CuPy

• DAMASK

• EnOSlib

• Fairlearn

• Feature-engine

• Jupyter

• Jupyter Book

• Matplotlib

• MegEngine

• MNE-Python

• NetworkX

• Numpy

• Pandas

• PhaseFieldX

• Pystra (PyRe的延续)

• PyVista

• SciPy

• Seaborn

• SEPAL

使用 Furo 主题的文档

Furo theme documentation

• Furo theme

• pytest

• Python Packaging User Guide

• Python开发者指南

使用自定义主题或集成在网站中的文档

• AIOHTTP

• Apache Cassandra

• Boto 3

• CakePHP

• Ceph

• Chef

• CKAN

• Confluent平台

• Django

• django CMS

• Doctrine

• Acrobat产品企业工具包

• FreeFEM

• fmt

• Gameduino

• gensim

• GeoServer

• gevent

• GHC - Glasgow Haskell 编译器

• Guzzle

• H2O.ai

• Heka

• Istihza（土耳其Python文档项目）

• 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用户手册（德文）

• 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

主页和其他非文档网站

• 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 (经典的，定制的)

• 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主题，定制的)

• SciPy Cookbook (sphinx_rtd主题)

• Tech writer at work blog (自定义主题)

• 加州大学伯克利分校ME233高级控制系统II课程 (sphinx文档)

• Željko Svedružić的生物分子结构与功能实验室 (BioSFLab) (sphinx_bootstrap_theme)

用sphinx制作的书籍

• “社区艺术” (日文译本)

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

• "Expert Python Programming"

• "Python编程专家" (日文译本)

• “python编程专家第二版”(日文译本)

• “python快速指南”

• "LassoGuide"

• “学习Sphinx” (日语)

• “用Go学习系统编程 (日语)"

• “Mercurial：最终指南（第二版）”

• "Mithril--最快的客户端MVC（日语）"

• 《犹他州的先驱者和杰出人物》

• “Pomodoro技术说明” (日文译本)

• “专业软件开发”

• "Python 高级编程" (日语)

• “Python专业编程第二版” (日语)

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

• 尤里·彼得罗夫的python课程（俄语）

• "Real World HTTP -- Learning The Internet and Web Technology via its history and code (Japanese)"

• “Redmine Primer第五版（日语）”

• "repoze.bfg框架Web应用程序"

• “自学编程的人” (日文译本)

• “简单逐步的学习软件工程的方法” (日语)

• "Software-Dokumentation mit Sphinx"

• “理论物理参考”

• “消失的书”

用sphinx撰写的论文

• “动态虚拟世界的内容调节和分发”

• "sphinx论文资源"

集成Sphinx功能的项目

• Read the Docs，一个软件即服务的文档托管平台，使用Sphinx自动构建文档更新，并将其推送到GitHub。

• Spyder，科学Python开发环境，在其帮助窗格中使用Sphinx来自动或按需呈现函数、类和方法的丰富文档。

Previous

Sphinx 0.1