diff options
| author | Carlton Gibson <carlton.gibson@noumenal.es> | 2025-03-22 14:27:36 +0100 |
|---|---|---|
| committer | Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> | 2025-03-27 17:36:21 +0100 |
| commit | ec2af58ac6ee606b86b675ba4d00dba7219aa19f (patch) | |
| tree | 15b1dad6f9063a555639fc16bd9ac3c4ac748732 | |
| parent | 06f621f359875c3f2e8dd97b128dd5db87657d2b (diff) | |
[5.2.x] Doc'd how to use Intersphinx in the reusable apps tutorial.
Backport of 6e54e20cc3908d4eb103678db14e1e02e05069dd from main.
| -rw-r--r-- | docs/intro/reusable-apps.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index 5acf8c2b18..71696ce0ee 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -264,6 +264,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 <https://readthedocs.org>`_. + Many Python projects, including Django and Python itself, use `Sphinx + <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_ to build + their documentation. If you choose to use Sphinx you can link back to the + Django documentation by configuring `Intersphinx + <https://www.sphinx-doc.org/en/master/usage/quickstart.html#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 |
