Opened 13 years ago

Closed 13 years ago

#3333 closed (fixed)

Documentation should use relative links, not hard-coded links

Reported by: Adrian Holovaty Owned by: Jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: smileychris+django@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


As suggested in this django-developers thread, every document in our docs directory should have its links converted to relative links. This will make it easier for people to view documentation as HTML locally (see #528) and will solve the problem of old documentation linking to new documentation.

I made an example change in [4358].

Attachments (2)

relative_doc_paths.diff (55.8 KB) - added by Jacob 13 years ago.
3333-db-api.diff (1.1 KB) - added by ramiro <rm0 _at_> 13 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 13 years ago by Chris Beaven

Cc: smileychris+django@… added
Has patch: set

I have a ticket ready with this all in it. When trac accepts tickets again I'll put it in.

Any instances of the absolute URL that I left were references to the online version (or examples of links).

Changed 13 years ago by Jacob

Attachment: relative_doc_paths.diff added

comment:2 Changed 13 years ago by Chris Beaven

Triage Stage: AcceptedReady for checkin

Thanks, jacob. Don't know why it wouldn't upload for me...

comment:3 Changed 13 years ago by Adrian Holovaty

Resolution: fixed
Status: newclosed

(In [4420]) Fixed #3333 -- Docs now use relative links, not hard-coded links. Thanks for the patch, SmileyChris

comment:4 Changed 13 years ago by ramiro <rm0 _at_>

Please consider reopening this ticket and applying the attached patch
that modifies the links in the db-api documentation so they are relative.
It was missed in the original patch.

Changed 13 years ago by ramiro <rm0 _at_>

Attachment: 3333-db-api.diff added

comment:5 Changed 13 years ago by Ramiro Morales <rm0 _at_>

Resolution: fixed
Status: closedreopened

developers won't know about the mini-patch if they don't see it the ticket reopened, so here we go...

comment:6 Changed 13 years ago by Malcolm Tredinnick

Resolution: fixed
Status: reopenedclosed

(In [4681]) Fixed #3333 -- Made db-api.txt links relative, in line with the other docs.
Thanks, Ramiro Morales.

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