Using Sphinx and Doctests to Provide Robust Documentation

php|works / PyWorks 2008
At a Glance

Location: Atlanta, GA
Dates: Nov. 12 (tutorials)
Nov. 13-14 (main)
Tutorials: 10
Talks: 65
Presented By






Become a sponsor or media sponsor today!
Media Sponsors










Become a sponsor or media sponsor today!
Day #2: November 14, 2008 @ 09:00 – 10:00
Presented by: Chris Perkins
Talk focus: Python

There has been a lot of buzz in the Python community about Pythons new standard in Documentation systems. This talk starts with a discussion about the motivation for using sphinx. We then move on to a short screencast which demonstrates how to get started with sphinx, and how to utilize sphinx's autodoc features. I will then discuss shortly doctests, and how they can be used to both test and document your project. Next I demonstrate how nosetests, and sphinx can be integrated in your development process to produce well tested documentation, using another short screencast.