Projetos usando Sphinx

Esta é uma lista incompleta de projetos que usam o Sphinx para sua documentação. Se você quiser adicionar um projeto, por favor, crie um relatório de problema ou pull request no GitHub.

Eu agrupei a list em seções para facilitar encontrar exemplos interessantes.

Documentação usando o tema alabaster

• Alabaster

• Blinker

• Calibre

• CherryPy

• Click (personalizado)

• coala (personalizado)

• CodePy

• Django Q

• Eve (framework em Python de API REST)

• Fabric

• Fityk

• Flask

• Flask-OpenID

• Invoke

• Jinja

• Lino (personalizado)

• Linux kernel (personalizado)

• marbl

• MeshPy

• Molecule

• Momotor LTI

• Podman

• PyCUDA

• PyOpenCL

• PyLangAcq

• python-apt

• PyVisfile

• Requests

• searx

• Spyder (personalizado)

• Tablib

• urllib3 (personalizado)

• Werkzeug

• Write the Docs

Documentação usando o tema clássico

• Advanced Generic Widgets (personalizado)

• Apache CouchDB (personalizado)

• APSW

• Arb

• Beautiful Soup

• API do Blender

• Bugzilla

• Buildbot

• CMake (personalizado)

• Chaco (personalizado)

• DEAP (personalizado)

• Director

• EZ-Draw (personalizado)

• Generic Mapping Tools (GMT) (personalizado)

• Genomedata

• GetFEM (personalizado)

• Glasgow Haskell Compiler (personalizado)

• Grok (personalizado)

• GROMACS

• GSL Shell

• Hands-on Python Tutorial

• Kaa (personalizado)

• Leo (personalizado)

• Mayavi (personalizado)

• MediaGoblin (personalizado)

• mpmath

• OpenCV (personalizado)

• OpenEXR

• OpenGDA

• phpDocumentor (personalizado)

• Plone (personalizado)

• PyEMD

• Pyevolve

• Pygame (personalizado)

• PyMQI

• PyQt4 (personalizado)

• PyQt5 (personalizado)

• Python 2

• Python 3 (personalizado)

• Python Packaging Authority (personalizado)

• Ring programming language (personalizado)

• SageMath (personalizado)

• Segway

• simuPOP (personalizado)

• SymPy

• TurboGears (personalizado)

• tvtk

• Varnish (personalizado, alabaster para o índice)

• Waf

• wxPython Phoenix (personalizado)

• z3c

• zc.async (personalizado)

• Zope (personalizado)

Documentação usando o tema sphinxdoc

• ABRT

• cartopy

• Jython

• LLVM

• PyCantonese

• Pyre

• pySPACE

• Pysparse

• PyTango

• Python Wild Magic (personalizado)

• RDKit

• Reteisi (personalizado)

• Turbulenz

Documentação usando o tema nature

• Alembic

• Cython

• easybuild

• libLAS (personalizado)

• Lmod

• MapServer (personalizado)

• PyWavelets

• Setuptools

• Spring Python

• StatsModels (personalizado)

• Sylli

Documentação usando outro tema embutido

• Breathe (haiku)

• Breezy (fork do Bazaar) (agogo)

• MPipe (sphinx13)

• NLTK (agogo)

• PyPubSub (bizstyle)

• Pylons (pyramid)

• Pyramid web framework (pyramid)

• RxDock (bizstyle)

• Sphinx (sphinx13) :-)

• Valence (haiku, personalizado)

Documentação usando o Read the Docs Sphinx Theme

Documentação do Read the Docs Sphinx Theme

• Aesara (fork do Theano)

• Annotator

• Ansible (personalizado)

• Arcade

• aria2

• ASE

• asvin

• Autofac

• BigchainDB

• Blender Reference Manual

• Blocks

• bootstrap-datepicker

• Certbot

• CKAN

• Copr Buildsystem (personalizado)

• Coreboot

• Chainer (personalizado)

• citeproc-js

• cloud-init

• CodeIgniter

• Conda

• Corda

• Dask

• Databricks (personalizado)

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

• HDF5 for Python (h5py)

• HyperKitty

• Hyperledger Fabric

• IdentityServer

• Idris

• Inkscape (personalizado)

• javasphinx

• Jupyter Notebook

• Kanboard

• Lasagne

• latexindent.pl

• Learning Apache Spark with Python

• LibCEED

• Linguistica

• Mailman

• MathJax

• MDTraj (personalizado)

• Mesa 3D

• micca - MICrobial Community Analysis

• MicroPython

• Mink

• Mockery

• mod_wsgi

• MoinMoin

• Mopidy

• mpi4py

• MyHDL

• Mypy

• Netgate Docs

• Nextcloud Server

• Nextflow

• nghttp2

• NICOS (personalizado)

• OpenFAST

• Panda3D (personalizado)

• Pelican

• picamera

• Pillow

• pip

• Paver

• peewee

• Phinx

• phpMyAdmin

• PHPUnit

• PHPWord

• PROS (personalizado)

• Pweave

• pyca/cryptograhpy

• pyglet

• PyNaCl

• pyOpenSSL

• PyPy

• python-sqlparse

• PyVISA

• Read The Docs

• RenderDoc

• ROCm Platform

• Free your information from their silos (francês) (personalizado)

• Extensão “Releases” para Sphinx

• Qtile

• Quex

• QuTiP

• Sawtooth

• Scapy

• SimGrid

• SimPy

• six

• Solidity

• Sonos Controller (SoCo)

• Sphinx AutoAPI

• sphinx-argparse

• sphinx-tabs

• Sphinx-Gallery (personalizado)

• Sphinx with Github Webpages

• SpotBugs

• StarUML

• Sublime Text Unofficial Documentation

• SunPy

• Sylius

• Syncthing

• Tango Controls (personalizado)

• ThreatConnect

• TrueNAS (personalizado)

• Tuleap

• TYPO3 (personalizado)

• Veyon

• Ubiquity

• uWSGI

• virtualenv

• Wagtail

• Web Application Attack and Audit Framework (w3af)

• Weblate

• x265

• Zeek

• Zulip

Documentação usando Sphinx Bootstrap Theme

Documentação do Sphinx Bootstrap Theme

• Bootstrap Theme

• C/C++ Software Development with Eclipse

• Dataverse

• e-cidadania

• Hangfire

• Hedge

• ObsPy

• OPNFV

• Pootle

• PyUblas

• seaborn

Documentação usando PyData Sphinx Theme

Documentação do Pydata Sphinx Theme

• Arviz

• Astropy

• Binder

• Bokeh

• CuPy

• DAMASK

• EnOSlib

• Fairlearn

• Feature-engine

• Jupyter

• Jupyter Book

• Matplotlib

• MegEngine

• MNE-Python

• NetworkX

• Numpy

• Pandas

• PhaseFieldX

• Pystra (continuação de PyRe)

• PyVista

• SciPy

• Seaborn

• SEPAL

Documentação usando o tema Furo

Documentação do tema Furo

• Tema Furo

• pytest

• Guia de Usuário para Empacotamento de Python

• Python Developer’s Guide

Documentação usando um tema personalizado ou integrado em um website

• 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 (Projeto turco de documentação de 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 (Alemão)

• PSI4

• PyMOTW

• python-aspectlib (sphinx_py3doc_enhanced_theme)

• QGIS

• Roundup

• SaltStack

• scikit-learn

• Scrapy

• Selenium

• Self

• Substance D

• Sulu

• SQLAlchemy

• tinyTiM

• Twisted

• Guia de empacotamento do Ubuntu

• WTForms

Páginas iniciais e outros sites que não são de documentação

• Using the Django REST Framework and DRF-JSONAPI, de Alan Crosswell

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

• Benoit Boissinot (clássico, personalizado)

• Cloud Consultancy Team da EBI (sphinx_rtd_theme)

• Eric Holscher (alabaster)

• Florian Diesch

• Institute for the Design of Advanced Energy Systems (IDAES) (sphinx_rtd_theme)

• Exemplos do IDAES (sphinx_rtd_theme)

• Notas de aula de mecânica estatística de Lei Ma (sphinx_bootstrap_theme)

• PyXLL (sphinx_bootstrap_theme, personalizado)

• SciPy Cookbook (sphinx_rtd_theme)

• Blog “Tech writer at work” (tema personalizado)

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

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

Livros produzidos usando Sphinx

• “The Art of Community” (tradução para japonês)

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

• “Expert Python Programming”

• “Expert Python Programming” (tradução para japonês)

• “Expert Python Programming 2nd Edition” (tradução para japonês)

• “The Hitchhiker’s Guide to Python”

• “LassoGuide”

• “Learning Sphinx” (em japonês)

• “Learning System Programming with Go (japonês)”

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

• “Mithril – The fastest clientside MVC (japonês)”

• “Pioneers and Prominent Men of Utah”

• “Pomodoro Technique Illustrated” (tradução para japonês)

• “Professional Software Development”

• “Python Professional Programming” (em japonês)

• “Python Professional Programming 2nd Edition” (em japonês)

• “Python Professional Programming 3rd Edition” (em japonês)

• Curso de Python por Yuri Petrov (Russo)

• “Real World HTTP – Learning The Internet and Web Technology via its history and code (japonês)”

• “Redmine Primer 5th Edition (em japonês)”

• “The repoze.bfg Web Application Framework”

• “The Self-Taught Programmer” (tradução para japonês)

• “Simple and Steady Way of Learning for Software Engineering” (em japonês)

• “Software-Dokumentation mit Sphinx”

• “Theoretical Physics Reference”

• “The Varnish Book”

Produções usando Sphinx

• “Content Conditioning and Distribution for Dynamic Virtual Worlds”

• “The Sphinx Thesis Resource”

Projetos integrando a funcionalidade do Sphinx

• Read the Docs, a software-as-a-service documentation hosting platform, uses Sphinx to automatically build documentation updates that are pushed to GitHub.

• Spyder, o Scientific Python Development Environment, usa o Sphinx em seu painel de ajuda para renderizar documentação rica para funções, classes e métodos automaticamente ou sob demanda.

Previous

Sphinx 0.1