Projects using Sphinx¶
Contents
Nice doc¶
- Askbot
- Bottle.py
- Python USB API for Canon digital cameras
- Ceph
- Django
- Exquires
- Dpm
- Eyesopen
- Sphinx gammu documentation
- github2 using sphinx
- Macaron: Python O/R Mapper
- Mediagobelin
- Parcel (html_theme = ‘flask’)
- Pylons
- PysSCes
- Python GTK+ 3 Tutorial
- Python
- Sphinx Prody documentation
- Requests
- Simpy Documentation
- Sphinx
- SQLAlchemy 0.7 Documentation
- Urwid Documentation
Non python projects¶
I have heard a few times over the past couple months that Sphinx is “mainly for Python projects”. This line of thinking makes sense, because Sphinx was created to document Python itself. Sphinx however, is a generic documentation tool that is capable of documenting any software project.
The goal of Sphinx is to help you write prose documentation. Prose docs work great for any kind of software you are documenting.
What it doesn’t handle particularly well is generation of docs from source code.
This is a task that is best left to a language-specific tooling, so I don’t see this as a major downside of Sphinx.