Cool Python Documentation Utilities

Sun 16 September 2007 by Thejaswi Puthraya

Cool Python Documentation Utilities

It's been a long time since I blogged. Part of the reason was laziness and the other part was that I needed good content to blog on. Now I have overcome both and here's my new post.

I have learnt from my experience that users (and developers alike!!!) mainly adopt projects which have comprehensive documentation. Just look at some of the most successful OSS projects, they devote a lot of time and energy to write and update documentation.

Here are two cool projects that I checked out to jazz my project!!! Two such projects would be:

  • Docutils:Docutils is an open-source text processing system for processing plaintext documentation into useful formats, such as HTML or LaTeX. It includes reStructuredText, the easy to read, easy to use, what-you-see-is-what-you-get plaintext markup language. Using the simple markup language of Docutils one can generate documentation for their project in various formats without having to work on them individually. Check out a cool looking example -> Restructured Text Source transformed to Result
  • Epydoc:Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. Most Python developers have the habit of writing docstrings. By using epydoc one can generate API documentation based on docstrings, comments and doc-tests. Check out Django's API auto-generated using Epydoc.

My project documentation is now based on reStructured Text and I have generated API documentation using epydoc (converted to PDF) available here.