diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/admin/admindocs.txt | 9 | ||||
| -rw-r--r-- | docs/releases/5.2.txt | 5 |
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt index edc29b4a5c..240def8efb 100644 --- a/docs/ref/contrib/admin/admindocs.txt +++ b/docs/ref/contrib/admin/admindocs.txt @@ -31,6 +31,8 @@ Once those steps are complete, you can start browsing the documentation by going to your admin interface and clicking the "Documentation" link in the upper right of the page. +.. _admindocs-helpers: + Documentation helpers ===================== @@ -47,6 +49,13 @@ Template filters ``:filter:`filtername``` Templates ``:template:`path/to/template.html``` ================= ======================= +Each of these support custom link text with the format +``:role:`link text <link>```. For example, ``:tag:`block <built_in-block>```. + +.. versionchanged:: 5.2 + + Support for custom link text was added. + Model reference =============== diff --git a/docs/releases/5.2.txt b/docs/releases/5.2.txt index 8327de7405..d07e9cb098 100644 --- a/docs/releases/5.2.txt +++ b/docs/releases/5.2.txt @@ -44,7 +44,10 @@ Minor features :mod:`django.contrib.admindocs` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* ... +* Links to components in docstrings now supports custom link text, using the + format ``:role:`link text <link>```. See :ref:`documentation helpers + <admindocs-helpers>` for more details. + :mod:`django.contrib.auth` ~~~~~~~~~~~~~~~~~~~~~~~~~~ |