Opened 5 years ago

Closed 5 years ago

#12894 closed (fixed)

Not-so-nice anchor for section titles in docs.djangoproject.com

Reported by: anonymous Owned by: nobody
Component: *.djangoproject.com Version: master
Severity: Keywords: model validation
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

On http://docs.djangoproject.com/en/dev/ref/models/instances/ the anchor for "Validating objects" is currently "#id1".
Other anchors in the Django doc are human readable. Cool URIs don't change (and I already referenced this anchor somewhere), but maybe it should change to "#validating-objects".

Change History (5)

comment:1 Changed 5 years ago by russellm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to wontfix
  • Status changed from new to closed

I'm in complete agreement that the anchors aren't nice, but I'm not sure there is anything we can do about it. The #id1 tags are autogenerated by Sphinx, which is what we use to generate our documentation.

Please reopen if anyone knows enough Sphinx-fu to provide a workable solution.

comment:2 Changed 5 years ago by ramiro

  • Component changed from Documentation to Django Web site
  • Resolution wontfix deleted
  • Status changed from closed to reopened
  • Summary changed from Not-so-nice anchor to Not-so-nice anchor for section titles in docs.djangoproject.com

I've tested this by generating the documentation locally with different relases of Sphinx and it gets solved by simply using version 0.6.

So, the solution for the docs.djangoproject.com site would be to upgrade the Sphinx component of the setup used there from 0.4.x (the version I suspect is being used currently). I don't know what else that migration would involve but I suspet it would also allow to drop a few hacks we are currently using in docs/_ext/djangodocs.py.

Reopening and changing Component field value.

comment:3 Changed 5 years ago by russellm

  • milestone set to 1.2
  • Triage Stage changed from Unreviewed to Accepted

comment:4 Changed 5 years ago by ubernostrum

  • milestone 1.2 deleted

If upgrading djangoproject.com's Sphinx fixes this, then it's not a problem in Django itself and shouldn't be on a milestone.

comment:5 Changed 5 years ago by ramiro

  • Resolution set to fixed
  • Status changed from reopened to closed

This has been fixed at some point. Quite probably when the version of Sphinx used on doc.djangoproject.com was updated to 1.0.x.

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