Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#3046 closed enhancement (invalid)

make documentation available as a zip package

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

Description

could you make the latest django documentation available as a package of html files? i often program when on the road/offline and having the docs would be very helpful

thank you
-yanda

Change History (4)

comment:1 Changed 10 years ago by Jacob

Resolution: invalid
Status: newclosed

The plaintext source is available in the distribution or SVN repository for offline reading; see the docs/ directory.

comment:2 Changed 10 years ago by Thomas Steinacher <tom@…>

Maybe there should be an easy way to generate HTML files because the docs are only available in .txt format.

comment:3 Changed 10 years ago by James Bennett

Thomas, the docs in the download and the repo are in reStructuredText format, so they're readable as plaintext and can be transformed into other formats by docutils; that's actually how the HTML versions for the online documentation are generated. Take a look at the "build_documentation" script in the Django website code for an example: http://code.djangoproject.com/browser/djangoproject.com/django_website/apps/docs/parts/build_documentation.py

comment:4 Changed 10 years ago by James Bennett

Or, if you just want simplicity and no fancy formatting in the HTML output, see here for docs on ReST to HTML conversion:

http://docutils.sourceforge.net/README.html#quick-start

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