search

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

Link to Django docs where possible #17

Closed rixx closed 5 years ago

rixx commented 5 years ago

This PR introduces links to the Django documentation on all model fields that are Django core fields. (Yes, this leaves out fields like contrib.postgres, but it's better than nothing, imo).

vdboor commented 5 years ago

While I appreciate what you're trying to do here, this is not the right approach. Instead of linking to a HTTP URL, a proper intersphinx configuration in your project will do that all for you.

This makes sure that linking like these are in fact linked to the Django documentation: :class:`~django.contrib.auth.models.User`