Opened 3 weeks ago

Closed 3 weeks ago

#37374 closed Cleanup/optimization (fixed)

Unused hyperlink targets in the docs point to nonexistent pages

Reported by: Max Azatian Owned by: Max Azatian
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Nine named hyperlink targets in the docs are never referenced, and each one points at a URL that doesn't exist on docs.djangoproject.com. They are leftovers from an older docs layout, e.g. .. _forms documentation: ../forms/ in docs/howto/custom-model-fields.txt resolves to ​https://docs.djangoproject.com/en/dev/howto/forms/, which is a 404.

The targets, on main at 4fab678:

  • docs/howto/custom-model-fields.txt: helper functions (../forms/#generating-forms-for-models) and forms documentation (../forms/)
  • docs/ref/contrib/sitemaps.txt: URLconf (../url_dispatch/)
  • docs/ref/templates/language.txt: The Django template language: For Python programmers (../templates_python/)
  • docs/topics/i18n/translation.txt: settings file (../settings/), middleware documentation (../middleware/), session (../sessions/) and request object (../request_response/#httprequest-objects)
  • docs/topics/settings.txt: django-admin (../django-admin/)

None of them is used as name_ or `name`_ anywhere in its file, and docutils only resolves named references within the same document, so removing them changes no rendered output. Each URL above, resolved against its page's published address, returns 404.

Suggested fix: delete the nine targets (13 lines including adjacent blank lines).

Change History (2)

comment:1 by Tim Graham, 3 weeks ago

Triage Stage: Unreviewed → Ready for checkin

comment:2 by Jacob Walls <jacobtylerwalls@…>, 3 weeks ago

Resolution: → fixed
Status: assigned → closed

In 6b58ab0:

Fixed #37374 -- Removed unused hyperlink targets pointing to nonexistent docs pages.

Note: See TracTickets for help on using tickets.
Back to Top