Code

Opened 7 years ago

Closed 7 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@…> 7 years ago.

Download all attachments as: .zip

Change History (6)

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

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Summary changed from Link broken in the 'How to read the Django documentation' page to build_documentation.py has been removed but is still mentioned in the 'How to read the Django documentation' page
  • Triage Stage changed from Unreviewed to Design 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 7 years ago by mtredinnick

  • Triage Stage changed from Design decision needed to Accepted

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 7 years ago by SmileyChris

  • Needs documentation set

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

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

  • Has patch set
  • Needs documentation unset

comment:5 Changed 7 years ago by adrian

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

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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.