sejo's rants

I'm using Django for Djagios and use Sphinx for the docs and website. However I've been trying to incorporate my documentation as much as possible into the code. So I started using attribute docstrings on my models. Right now it's in a separate file (http://docs.djagios.org/core/models.html).

You'll notice that it's a huge list of attributes. Now the problem lies in Django's way of working with attributes, set me demonstrate the problem:

[python] class Author(models.Model): name = models.CharField(max_length=100) """Docstring for name"""

class Book(models.Model): name = models.CharField(max_length=255) """Another Docstring""" author = models.ForeignKey(Author) """Each book has an Author""" [/python] Will result in a documentation with only the docstrings of Book.author.

painfull!