Projets utilisant Sphinx

Il s’agit d’une liste alphabétique (incomplète) de projets utilisant Sphinx ou expérimentant de l’utiliser pour sa documentation. Si vous souhaitez être inclus, veuillez envoyer un courrier électronique au groupe Google. <https://groups.google.com/forum/#!forum/sphinx-users>`_.

J’ai regroupé la liste en sections afin de faciliter la recherche d’exemples intéressants.

Documentation utilisant le thème alabaster

• Alabaster

• Blinker

• Calibre

• CherryPy

• `Click `__ (personnalisé)

• coala (personnalisé)

• CodePy

• Django Q

• Eve (Python REST API framework)

• Fabric

• Fityk

• Flask

• Flask-OpenID

• Invoke

• Jinja

• `Lino `__ (personnalisé)

• marbl

• MeshPy

• Molecule

• Momotor LTI

• Podman

• PyCUDA

• PyOpenCL

• PyLangAcq

• pytest (personnalisé)

• python-apt

• PyVisfile

• Requests

• searx

• Spyder (personnalisé)

• Tablib

• urllib3 (personnalisé)

• Werkzeug

• Write the Docs

Documentation utilisant le thème classique

• `Advanced Generic Widgets `__ (personnalisé)

• `Apache CouchDB `__ (personnalisé)

• APSW

• Arb

• Beautiful Soup

• API Blender

• Bugzilla

• Buildbot

• CMake (personnalisé)

• Chaco (personnalisé)

• DEAP (personnalisé)

• Director

• EZ-Draw (customized)

• Generic Mapping Tools (GMT) (personnalisé)

• Genomedata

• GetFEM (customized)

• Glasgow Haskell Compiler (personnalisé)

• Grok (customized)

• GROMACS

• GSL Shell

• Hands-on Python Tutorial

• Kaa (customized)

• Leo (customized)

• Mayavi (personnalisé)

• MediaGoblin (personnalisé)

• mpmath

• OpenCV (personnalisé)

• OpenEXR

• OpenGDA

• phpDocumentor (customized)

• Plone (personnalisé)

• PyEMD

• Pyevolve

• Pygame (Personnalisé)

• PyMQI

• PyQt4 (customized)

• PyQt5 (customized)

• Python 2

• Python 3 (personnalisé)

• Python Packaging Authority (personnalisé)

• Ring programming language (customized)

• SageMath (personnalisé)

• Segway

• simuPOP (customized)

• SymPy

• TurboGears (personnalisé)

• tvtk

• Varnish (personnalisé, alabaster pour les indexes )

• Waf

• wxPython Phoenix (personnalisé)

• z3c

• zc.async (personnalisé)

• Zope (customized)

Documentation utilisant le thème sphinxdoc

• ABRT

• cartopy

• Jython

• LLVM

• PyCantonese

• Pyre

• pySPACE

• Pysparse

• PyTango

• Python Wild Magic (personnalisé)

• RDKit

• Reteisi (customized)

• Sqlkit (customized)

• Turbulenz

Documentation utilisant le thème nature

• Alembic

• Cython

• easybuild

• libLAS (customized)

• Lmod

• MapServer (personnalisé)

• PyWavelets

• Setuptools

• Spring Python

• StatsModels (personnalisé)

• Sylli

Documentation utilisant un autre thème intégré

• 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, personnalisé)

Documentation utilisant le thème sphinx_rtd_theme

• Aesara (fork of Theano)

• Annotator

• Ansible (personnalisé)

• Arcade

• aria2

• ASE

• asvin

• Autofac

• BigchainDB

• Blender Manuel de référence

• Blocks

• bootstrap-datepicker

• Certbot

• CKAN

• Copr Buildsystem (customized)

• Coreboot

• Chainer (personnalisé)

• citeproc-js

• cloud-init

• CodeIgniter

• Conda

• Corda

• Dask

• Databricks (personnalisé)

• 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 (personnalisé)

• HDF5 pour Python (h5py)

• HyperKitty

• Hyperledger Fabric

• IdentityServer

• Idris

• Inkscape (customized)

• javasphinx

• Jupyter Notebook

• Kanboard

• Lasagne

• latexindent.pl

• Apprendre Apache Spark avec Python (anglais)

• LibCEED

• Linguistica

• Linux kernel

• 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 (personnalisé)

• OpenFAST

• Panda3D (customized)

• Pelican

• picamera

• Pillow

• pip

• Paver

• peewee

• Phinx

• phpMyAdmin

• PHPUnit

• PHPWord

• PROS (personnalisé)

• Pweave

• pyca/cryptograhpy

• pyglet

• PyNaCl

• pyOpenSSL

• PyPy

• python-sqlparse

• PyVISA

• Read The Docs

• RenderDoc

• ROCm Platform

• `Free your information from their silos (French) `__ (personnalisé)

• Releases Sphinx extension

• Qtile

• Quex

• QuTiP

• Sawtooth

• Scapy

• SimGrid

• SimPy

• six

• Solidity

• Sonos Controller (SoCo)

• Sphinx AutoAPI

• sphinx-argparse

• sphinx-tabs

• Sphinx-Gallery (personnalisé)

• Sphinx avec Github Webpages

• SpotBugs

• StarUML

• Sublime Text Unofficial Documentation

• SunPy

• Sylius

• Syncthing

• Tango Controls (personnalisé)

• ThreatConnect

• TrueNAS (customized)

• Tuleap

• TYPO3 (personnalisé)

• Veyon

• Ubiquity

• uWSGI

• virtualenv

• Wagtail

• Web Application Attack and Audit Framework (w3af)

• Weblate

• x265

• Zeek

• Zulip

Documentation utilisant le thème sphinx_bootstrap_theme

• Bootstrap Theme

• C/C++ Software Development with Eclipse

• Dataverse

• e-cidadania

• Hangfire

• Hedge

• ObsPy

• OPNFV

• Pootle

• PyUblas

• seaborn

Documentation using pydata_sphinx_theme

• Arviz

• Binder

• Bokeh

• CuPy

• EnOSlib

• Fairlearn

• Feature-engine

• Jupyter

• Jupyter Book

• Matplotlib

• MegEngine

• MNE-Python

• NetworkX

• Numpy

• Pandas

• Pystra (continuation of PyRe)

• PyVista

• SciPy

• SEPAL

Documentation utilisant un thème personnalisé ou intégrée dans un site Web

• AIOHTTP

• Apache Cassandra

• Astropy

• 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

• Seaborn

• Selenium

• Self

• Substance D

• Sulu

• SQLAlchemy

• tinyTiM

• Twisted

• Guide Ubuntu Packaging

• WTForms

Pages d’accueil et autres sites non documentés

• 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 (classique, personnalisé)

• 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, personnalisé)

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

Livres produits avec 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)

• « Développement professionnel de logiciels » (anglais)

• « Programmation Professionnelle en Python » (Japonais)

• « Python Professional Programming 2nd Edition » (in Japanese)

• « Python Professional Programming 3rd Edition » (in Japanese)

• Cours Python par Yuri Petrov (Russe)

• « 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 »

Thèses réalisées avec Sphinx

• « Content Conditioning and Distribution for Dynamic Virtual Worlds »

• « The Sphinx Thesis Resource »

Projets intégrant la fonctionnalité Sphinx

• Read the Docs, une plate-forme d’hébergement de documentation logicielle en tant que service, utilise Sphinx pour créer automatiquement des mises à jour de documentation transmises à 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.