Chapter 13. Documentation

In this chapter, you'll learn about the tools you can use to document your Pylons applications. Documentation can take a number of forms:

  • Source code documentation (comments and docstrings)

  • API documentation

  • User guides

  • Developer guides

The combination of approaches you choose to use for your project will depend on who will be using it and in what manner. For example, if you are developing an application on your own for your home page, you might decide that source code documentation is sufficient. If you are writing a library to support a Pylons application and you hope other developers will use it, then API documentation will be important. If you are creating an application like the SimpleSite tutorial application that might ...

Get The Definitive Guide to Pylons now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.