-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Jochen Maes schrieb: > \\//, > > > 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.
Hi Jochen, I don't understand why only Book.author is documented; is it because of some differences between models.ForeignKey and models.CharField? I'll certainly help where I can if you try to fix this in sphinx. cheers, Georg -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.11 (GNU/Linux) iEYEARECAAYFAkr3ElEACgkQN9GcIYhpnLAWWgCfVelMP5iWfcu9XraJzitrRKRP DOkAnivK4WiCMjp4yYo6/qvKoQmMR0pW =wiYx -----END PGP SIGNATURE----- --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~----------~----~----~----~------~----~------~--~---
