sphinx-doc / sphinxcontrib-django

This is a sphinx extension which improves the documentation of Django apps.
https://pypi.org/project/sphinxcontrib-django/
Apache License 2.0
45 stars 25 forks source link

Allow to override the docstrings for fields #14

Closed rixx closed 5 years ago

rixx commented 5 years ago

If I have a simple model, and the verbose_name or help_text is public-facing and not what I'd like to see in my developer docs, I want to override the sphinxcontrib-django doc string by providing my own – but instead of overriding, I now have the same field documented twice.

(Bonus bug: the (SomeField) annotation provided by this package is found with the added to my additional documentation, not to the one generated by this package.)

vdboor commented 5 years ago

Merged, and fixed! Thanks!