使用Sphinx的项目¶
This is an (incomplete) alphabetic list of projects that use Sphinx or are experimenting with using it for their documentation. If you like to be included, please mail to the Google group.
I’ve grouped the list into sections to make it easier to find interesting examples.
使用alabaster主题的文档¶
- Alabaster
- Blinker
- Calibre
- Click (customized)
- coala (customized)
- CodePy
- Eve (Python REST API framework)
- Fabric
- Fityk
- Flask
- Flask-OpenID
- Invoke
- Jinja
- Lino (customized)
- marbl
- MDAnalysis (customized)
- MeshPy
- Molecule
- PyCUDA
- PyOpenCL
- PyLangAcq
- pytest (customized)
- python-apt
- PyVisfile
- Requests
- searx
- Spyder (customized)
- Tablib
- urllib3 (customized)
- Werkzeug (customized)
使用经典主题的文档¶
- Advanced Generic Widgets (customized)
- Apache CouchDB (customized)
- APSW
- Arb
- Bazaar (customized)
- Beautiful Soup
- Blender
- Bugzilla
- Buildbot
- CMake (customized)
- Chaco (customized)
- CORE
- CORE Python modules
- Cormoran
- DEAP (customized)
- Director
- EZ-Draw (customized)
- F2py
- Generic Mapping Tools (GMT) (customized)
- Genomedata
- GetFEM++ (customized)
- Glasgow Haskell Compiler (customized)
- Grok (customized)
- GROMACS
- GSL Shell
- Hands-on Python Tutorial
- Kaa (customized)
- Leo
- LEPL (customized)
- Mayavi (customized)
- MediaGoblin (customized)
- mpmath
- OpenCV (customized)
- OpenEXR
- OpenGDA
- Peach^3 (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)
- Sprox (customized)
- SymPy
- TurboGears (customized)
- tvtk
- Varnish (customized, alabaster for index)
- Waf
- wxPython Phoenix (customized)
- Yum
- z3c
- zc.async (customized)
- Zope (customized)
使用sphinxdoc主题的文档¶
- ABRT
- cartopy
- Jython
- Matplotlib
- MDAnalysis Tutorial
- NetworkX
- PyCantonese
- Pyre
- pySPACE
- Pysparse
- PyTango
- Python Wild Magic (customized)
- Reteisi (customized)
- Sqlkit (customized)
- Turbulenz
使用自然主题的文档¶
- Alembic
- Cython
- easybuild
- jsFiddle
- libLAS (customized)
- Lmod
- MapServer (customized)
- Pandas
- pyglet (customized)
- Setuptools
- Spring Python
- StatsModels (customized)
- Sylli
使用其他内置主题的文档¶
- Breathe (haiku)
- MPipe (sphinx13)
- NLTK (agogo)
- Programmieren mit PyGTK und Glade (German) (agogo, customized)
- PyPubSub (bizstyle)
- Pylons (pyramid)
- Pyramid web framework (pyramid)
- Sphinx (sphinx13) :-)
- Valence (haiku, customized)
使用sphinx_rtd_theme的文档¶
- Annotator
- Ansible (customized)
- Arcade
- aria2
- ASE
- Autofac
- BigchainDB
- Blocks
- bootstrap-datepicker
- Certbot
- Chainer (customized)
- CherryPy
- cloud-init
- CodeIgniter
- Conda
- Corda
- Dask
- Databricks (customized)
- Dataiku DSS
- DNF
- edX
- Electrum
- Elemental
- ESWP3
- Ethereum Homestead
- Faker
- Fidimag
- Flake8
- Flatpak
- FluidDyn
- Fluidsim
- GeoNode
- Glances
- Godot
- Graylog
- GPAW (customized)
- HDF5 for Python (h5py)
- Hyperledger Fabric
- Hyperledger Sawtooth
- IdentityServer
- Idris
- javasphinx
- Julia
- Jupyter Notebook
- Lasagne
- latexindent.pl
- Linguistica
- Linux kernel
- MathJax
- MDTraj (customized)
- MICrobial Community Analysis (micca)
- MicroPython
- Minds (customized)
- Mink
- Mockery
- mod_wsgi
- MoinMoin
- Mopidy
- MyHDL
- Nextflow
- NICOS (customized)
- Pelican
- picamera
- Pillow
- pip
- Paver
- peewee
- Phinx
- phpMyAdmin
- PROS (customized)
- Pushkin
- Pweave
- PyPy
- python-sqlparse
- PyVISA
- Read The Docs
- Free your information from their silos (French) (customized)
- Releases Sphinx extension
- Qtile
- Quex
- QuTiP
- Satchmo
- Scapy
- SimGrid
- SimPy
- six
- SlamData
- Solidity
- Sonos Controller (SoCo)
- Sphinx AutoAPI
- sphinx-argparse
- Sphinx-Gallery (customized)
- SpotBugs
- StarUML
- Sublime Text Unofficial Documentation
- SunPy
- Sylius
- Syncthing
- Tango Controls (customized)
- Topshelf
- Theano
- ThreatConnect
- Tuleap
- TYPO3 (customized)
- Veyon
- uWSGI
- virtualenv
- Wagtail
- Web Application Attack and Audit Framework (w3af)
- Weblate
- x265
- ZeroNet
- Zulip
使用sphinx_bootstrap_theme的文档¶
使用自定义主题或集成在网站中的文档¶
- Apache Cassandra
- Astropy
- Bokeh
- Boto 3
- CakePHP
- CasperJS
- Ceph
- Chef
- CKAN
- Confluent Platform
- Django
- Doctrine
- Enterprise Toolkit for Acrobat products
- Gameduino
- gensim
- GeoServer
- gevent
- GHC - Glasgow Haskell Compiler
- Guzzle
- H2O.ai
- Heka
- Istihza (Turkish Python documentation project)
- Kombu
- Lasso
- Mako
- MirrorBrain
- MongoDB
- Music21
- MyHDL
- nose
- ns-3
- NumPy
- ObjectListView
- OpenERP
- OpenCV
- OpenLayers
- OpenTURNS
- Open vSwitch
- PlatformIO
- PyEphem
- Pygments
- Plone User Manual (German)
- PSI4
- PyMOTW
- python-aspectlib (sphinx_py3doc_enhanced_theme)
- QGIS
- qooxdoo
- Roundup
- SaltStack
- scikit-learn
- SciPy
- Scrapy
- Seaborn
- Selenium
- Self
- Substance D
- Sulu
- SQLAlchemy
- tinyTiM
- Twisted
- Ubuntu Packaging Guide
- WebFaction
- WTForms
主页和其他非文档站点¶
- Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio-and Nanophysics (classic)
- Benoit Boissinot (classic, customized)
- Computer Networks, Parallelization, and Simulation Laboratory (CNPSLab) (sphinx_rtd_theme)
- Deep Learning Tutorials (sphinxdoc)
- Eric Holscher (alabaster)
- Lei Ma’s Statistical Mechanics lecture notes (sphinx_bootstrap_theme)
- Loyola University Chicago COMP 339-439 Distributed Systems course (sphinx_bootstrap_theme)
- Pylearn2 (sphinxdoc, customized)
- PyXLL (sphinx_bootstrap_theme, customized)
- SciPy Cookbook (sphinx_rtd_theme)
- The Wine Cellar Book (sphinxdoc)
- Thomas Cokelaer’s Python, Sphinx and reStructuredText tutorials (standard)
- 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” (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)
- “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)
- “软件工程学习的简单而稳定的方法” (用日语)
- “Software-Dokumentation mit Sphinx”
- “Theoretical Physics Reference”
- “The Varnish Book”
使用Sphinx制作的论文¶
集成Sphinx功能的项目¶
- Read the Docs, 软件即服务文档托管平台，使用Sphinx自动构建推送到GitHub的文档更新。
- Spyder, Scientific Python开发环境在其帮助窗格中使用Sphinx自动或按需呈现功能，类和方法的丰富文档。