[sphinx-dev] Django attribute documentation

[Jochen Maes]

\\//,


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 nom 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:

    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"""


Will result in a documentation with only the docstrings of Book.author.

As I really, really like sphinx I am asking if it's possible to (I'm
willing to patch myself with a bit of help) add this to the autodoc
extension.


llap,

Jochen Maes

-- 
ne humanus crede

pgp3jQCjoT4tH.pgp
Description: PGP signature