Using Sphinx and Doctests to provide Robust Documentation (#92)
Chris M. Perkins bio
30min ◊ Beginner
Sunday 11:10am, Ballroom D
categories:
doctest, sphinx, testing
There has been a lot of buzz in the Python community about Python's 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.
Files:
video:
# Permalink
.