Using Sphinx and Doctests to provide Robust Documentation (#92)

Chris M. Perkins (29.Mar.2009)
Talk at PyCon 2009 (English - US)

Rating: 0 of 5

There has been a lot of buzz in the Python community about Py thon's new standard in Documentation systems. This talk starts with a discu ssion about the motivation for using sphinx. We then move on to a short scr eencast which demonstrates how to get started with sphinx, and how to util ize sphinx's autodoc features. I will then discuss shortly doctests, and h ow they can be used to both test and document your project. Next I demonstr ate how nosetests, and sphinx can be integrated in your development proces s to produce well tested documentation, using another short screencast.

Who are you?

Claim talk

By clicking this button you are declaring that you are the speaker responsible for it and a claim request will be sent to the administrator of the event.

If the claim is approved you will be able to edit the information for this talk.

Are you sure?

Comments closed.
No comments yet.
© 2015