Opened 10 years ago

Closed 7 years ago

#9353 closed New feature (fixed)

Django documentation bundles on download page

Reported by: Tome <tome@…> Owned by: nobody
Component: * Version: master
Severity: Normal Keywords: download
Cc: loftarasa@… Triage Stage: Design decision needed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


After needing the django documentation for offline development I suggest the following:

Provide documentation packages (html, chm) on the download page for every release.

One can argue that it is possible to build it from the restructured text format, but I believe it makes sense to be able to download the html docs from the download page, and not having to learn how to compile them, or google around to find them at some other source.

Change History (10)

comment:1 Changed 10 years ago by zunzun

You can use wget to download and convert to local links:

wget -r -p -k


comment:2 Changed 10 years ago by Tim Graham

Triage Stage: UnreviewedDesign decision needed

comment:3 Changed 9 years ago by weirdnik

Keywords: download added
Version: 1.0SVN

The suggested fix does not work out of the box on platforms that don't have wget out of the box (for example mac os x). Google App Engine provides official documentation download.

comment:4 Changed 8 years ago by bcarneiro

I am a django user, fairly newbie. I did not find it easy to compile the html docs (in fact it's not pointed out that you have to do "make html" at the FAQ on how to read the documentation offline), which required me to download Sphinx. I don't see why this can't be provided at the download page.

comment:5 Changed 8 years ago by André Terra

+1 on this. one should also consider that developing on windows makes it just _that_ much harder to have local html copies of the documentation. do we really need makefiles for the documentation?

comment:6 Changed 8 years ago by André Terra

Cc: loftarasa@… added

comment:7 Changed 8 years ago by Gabriel Hurley

Component: DocumentationDjango Web site

This is an issue about the website itself, not about the docs.

comment:8 Changed 7 years ago by Luke Plant

Severity: Normal
Type: New feature

comment:9 Changed 7 years ago by anonymous

Easy pickings: unset

+1 to this. I'm about to get on a train; I go to the Django site and look for "Download HTML documentation tarball" and I would really have liked to have found it. It would be great if it wasn't true that everyone who wants this has to mess around with Sphinx and compiling docs themselves.


comment:10 Changed 7 years ago by Jacob

Resolution: fixed
Status: newclosed
UI/UX: unset

There're now links to offline versions in the sidebar on the docs site.

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