Opened 9 years ago

Closed 9 years ago

#4034 closed (fixed)

build_documentation.py has been removed but is still mentioned in the 'How to read the Django documentation' page

Reported by: jaywgraves@… Owned by: Jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

in http://code.djangoproject.com/browser/django/trunk/docs/documentation.txt

in the 'Formatting' section the link to build_documentation.py is broken.

It looks like this was refactored in [4789]

Attachments (1)

documentation.diff (1.1 KB) - added by Simon G. <dev@…> 9 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 Changed 9 years ago by Simon G. <dev@…>

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Summary: Link broken in the 'How to read the Django documentation' pagebuild_documentation.py has been removed but is still mentioned in the 'How to read the Django documentation' page
Triage Stage: UnreviewedDesign decision needed

It looks like this was removed when the website was changed to use a different system to build the docs. Not sure whether we should just remove this part from the docs, or just put the script elsewhere (or in the docs).

comment:2 Changed 9 years ago by Malcolm Tredinnick

Triage Stage: Design decision neededAccepted

We can just fix the docs to say "run rst2html on the files you care about" (with note about have restructured text package installed). It doesn't require a script.

comment:3 Changed 9 years ago by Chris Beaven

Needs documentation: set

Changed 9 years ago by Simon G. <dev@…>

Attachment: documentation.diff added

comment:4 Changed 9 years ago by Simon G. <dev@…>

Has patch: set
Needs documentation: unset

comment:5 Changed 9 years ago by Adrian Holovaty

Resolution: fixed
Status: newclosed

(In [5138]) Fixed #4034 -- Updated docs/documentation.txt to reflect the removal of build_documentation.py

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