From 6e54e20cc3908d4eb103678db14e1e02e05069dd Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Sat, 22 Mar 2025 14:27:36 +0100 Subject: [PATCH] Doc'd how to use Intersphinx in the reusable apps tutorial. --- docs/intro/reusable-apps.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index 8c12a36284..f097880f79 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -262,6 +262,26 @@ this. For a small app like polls, this process isn't too difficult. you add some files to it. Many Django apps also provide their documentation online through sites like `readthedocs.org `_. + Many Python projects, including Django and Python itself, use `Sphinx + `_ to build + their documentation. If you choose to use Sphinx you can link back to the + Django documentation by configuring `Intersphinx + `_ + and including a value for Django in your project's ``intersphinx_mapping`` + value:: + + intersphinx_mapping = { + # ... + "django": ( + "https://docs.djangoproject.com/en/stable/", + "https://docs.djangoproject.com/en/stable/_objects/", + ), + } + + With that in place, you can then cross-link to specific entries, in the + same way as in the Django docs, such as + "``:attr:`django.test.TransactionTestCase.databases```". + #. Check that the :pypi:`build` package is installed (``python -m pip install build``) and try building your package by running ``python -m build`` inside ``django-polls``. This creates a directory called ``dist`` and builds your