Fix broken external link in docs/introduction.txt Installing section #492
Description
TL;DR
The "Installing" section link in docs/introduction.txt uses incorrect RST syntax (:ref: for external URL) and points to /master/ which should be /latest/ for stable documentation.
Description
The docs/introduction.txt file in the django-celery-results repository contains a broken reference to the Celery documentation. The current ReStructuredText (RST) syntax incorrectly uses the :ref: role for an external URL, which is only valid for internal Sphinx references. Additionally, the URL points to /master/ which does not exist and should point to /latest/ for stable documentation.
Current Code (Broken)
Installing
The installation instructions for this extension is available from the :ref:Celery documentation .
- The above code tries to use :ref: for an external URL, which is incorrect.
- The :ref: role is designed for internal Sphinx cross-references, not external links.
- The link points to /master/ which does not exist: https://docs.celeryq.dev/en/master/django/first-steps-with-django.html#django-celery-results
Issue
- :ref: is meant for internal Sphinx references, not external URLs.
- The link text and reference target syntax is incorrect for external links.
- The documentation URL points to /master/ which does not exist; it must use /latest/ to point to stable documentation.
Proposed Fix
Use a named external link in proper RST syntax with correct URL:
- Defines a named external link Celery documentation.
- The trailing underscore _ correctly references the URL.
- Uses /latest/ in the URL which exists and points to stable documentation.
Changes
- Replaced invalid :ref: usage with proper RST external link syntax.
- Fixed the URL from /master/ to /latest/.
- Ensured that the link renders correctly and points to existing stable documentation.
Files Affected
- docs/introduction.txt
Screenshots
Motivation
This change ensures that the installation link renders correctly in the HTML documentation and points to existing stable documentation at /latest/ instead of the non-existent /master/ URL.
I would like to work on this issue and submit a PR.