使用 Sphinx 的项目

这是一个使用 Sphinx 进行文档编写的不完整项目列表。如果您想添加一个项目，请在 GitHub 上创建 issue 或 pull request。

我已将列表分组到各个部分，以便更容易找到有趣的示例。

使用 alabaster 主题的文档

• Alabaster

• Blinker

• Calibre

• CherryPy

• Click (自定义)

• coala (自定义)

• CodePy

• Django Q

• Eve (Python REST API 框架)

• Fabric

• Fityk

• Flask

• Flask-OpenID

• Invoke

• Jinja

• Lino (自定义)

• Linux kernel (自定义)

• marbl

• MeshPy

• Molecule

• Momotor LTI

• Podman

• PyCUDA

• PyOpenCL

• PyLangAcq

• python-apt

• PyVisfile

• Requests

• searx

• Spyder (自定义)

• Tablib

• urllib3 (自定义)

• Werkzeug

• Write the Docs

使用 classic 主题的文档

• Advanced Generic Widgets (自定义)

• Apache CouchDB (自定义)

• APSW

• Arb

• Beautiful Soup

• Blender API

• Bugzilla

• Buildbot

• CMake (自定义)

• Chaco (自定义)

• DEAP (自定义)

• Director

• EZ-Draw (自定义)

• Generic Mapping Tools (GMT) (自定义)

• Genomedata

• GetFEM (自定义)

• Glasgow Haskell Compiler (自定义)

• 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

使用 nature 主题的文档

• Alembic

• Cython

• easybuild

• libLAS (自定义)

• Lmod

• MapServer (自定义)

• PyWavelets

• Setuptools

• Spring Python

• StatsModels (自定义)

• Sylli

使用其他内置主题的文档

• Breathe (haiku)

• Breezy (Bazaar 分支) (agogo)

• MPipe (sphinx13)

• NLTK (agogo)

• PyPubSub (bizstyle)

• Pylons (pyramid)

• Pyramid web framework (pyramid)

• RxDock (bizstyle)

• Sphinx (sphinx13) :-)

• Valence (haiku, 自定义)

使用 Read the Docs Sphinx Theme 的文档

Read the Docs Sphinx Theme 文档

• Aesara (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 Community Analysis

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

• sphinx-tabs

• Sphinx-Gallery (自定义)

• Sphinx with Github Webpages

• SpotBugs

• StarUML

• Sublime Text Unofficial Documentation

• SunPy

• Sylius

• Syncthing

• Tango Controls (自定义)

• ThreatConnect

• TrueNAS (自定义)

• Tuleap

• TYPO3 (自定义)

• Veyon

• Ubiquity

• uWSGI

• virtualenv

• Wagtail

• Web Application Attack and Audit Framework (w3af)

• Weblate

• x265

• Zeek

• Zulip

使用 Sphinx Bootstrap Theme 的文档

Sphinx Bootstrap Theme 文档

• Bootstrap Theme

• C/C++ Software Development with Eclipse

• Dataverse

• e-cidadania

• Hangfire

• Hedge

• ObsPy

• OPNFV

• Pootle

• PyUblas

• seaborn

使用 PyData Sphinx Theme 的文档

Pydata Sphinx Theme 文档

• Arviz

• Astropy

• Binder

• Bokeh

• CuPy

• EnOSlib

• Fairlearn

• Feature-engine

• Jupyter

• Jupyter Book

• Matplotlib

• MegEngine

• MNE-Python

• NetworkX

• Numpy

• Pandas

• PhaseFieldX

• Pystra (PyRe 的延续)

• PyVista

• SciPy

• Seaborn

• SEPAL

使用 Furo theme 的文档

Furo theme 文档

• 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 (土耳其语 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 User Manual (德语)

• 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 的 Using the Django REST Framework and DRF-JSONAPI

• Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio-and Nanophysics (classic)

• Benoit Boissinot (classic, 自定义)

• 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, 自定义)

• SciPy Cookbook (sphinx_rtd_theme)

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

• UC Berkeley ME233 Advanced Control Systems II course (sphinxdoc)

• Željko Svedružić’s Biomolecular Structure and Function Laboratory (BioSFLab) (sphinx_bootstrap_theme)

使用 Sphinx 制作的书籍

• “The Art of Community” (日语翻译)

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

• “Expert Python Programming”

• “Expert Python Programming” (日语翻译)

• “Expert Python Programming 2nd Edition” (日语翻译)

• “The Hitchhiker’s Guide to Python”

• “LassoGuide”

• “Learning Sphinx” (日语)

• “Learning System Programming with Go (日语)”

• “Mercurial: the definitive guide (Second edition)”

• “Mithril – The fastest clientside MVC (日语)”

• “Pioneers and Prominent Men of Utah”

• “Pomodoro Technique Illustrated” (日语翻译)

• “Professional Software Development”

• “Python Professional Programming” (日语)

• “Python Professional Programming 2nd Edition” (日语)

• “Python Professional Programming 3rd Edition” (日语)

• Yuri Petrov 的 Python 课程 (俄语)

• “Real World HTTP – Learning The Internet and Web Technology via its history and code (日语)”

• “Redmine Primer 5th Edition (日语)”

• “The repoze.bfg Web Application Framework”

• “The Self-Taught Programmer” (日语翻译)

• “Simple and Steady Way of Learning for Software Engineering” (日语)

• “Software-Dokumentation mit Sphinx”

• “Theoretical Physics Reference”

• “The Varnish Book”

使用 Sphinx 制作的论文

• “Content Conditioning and Distribution for Dynamic Virtual Worlds”

• “The Sphinx Thesis Resource”

集成 Sphinx 功能的项目

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

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

上一页

Sphinx 0.1