From 7ce571ef015705a8e19994f68dd71d0a32f95390 Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Mon, 23 Jan 2006 23:16:39 +0000 Subject: [PATCH] Added 'How can I download the Django documentation to read it offline?' to docs/faq.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@2119 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/faq.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/faq.txt b/docs/faq.txt index cace552895..00fb881c7d 100644 --- a/docs/faq.txt +++ b/docs/faq.txt @@ -166,6 +166,22 @@ In the meantime, though, check out this `unofficial Django screencast`_. .. _unofficial Django screencast: http://www.throwingbeans.org/django_screencasts.html +How can I download the Django documentation to read it offline? +--------------------------------------------------------------- + +The Django docs are available in the ``docs`` directory of each Django tarball +release. These docs are in ReST (restructured text) format, and each text file +corresponds to a Web page on the official Django site. + +Because the documentation is `stored in revision control`_, you can browse +documentation changes just like you can browse code changes. + +Technically, the docs on Django's site are generated from the latest development +versions of those ReST documents, so the docs on the Django site may offer more +information than the docs that come with the latest Django release. + +.. _stored in revision control: http://code.djangoproject.com/browser/django/trunk/docs + Installation questions ======================