django

History

Malcolm Tredinnick 6add6170c0 Small reorganisation of initial parts of URL documentation. Trying to move most of the introductory example stuff up to the top and pushing the reference bits further down.		2012-09-07 19:12:14 -04:00
..
_ext	Made more extensive usage of context managers with open.	2012-05-05 14:06:36 +02:00
_theme/djangodocs	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
faq	Fixed typo from `7435cc01`.	2012-09-07 17:37:08 -04:00
howto	[py3] Ported django.utils.safestring.	2012-08-18 16:04:06 +02:00
internals	Fixed #18647 - Removed link to Malcolm's blog which is gone.	2012-08-30 07:44:41 -04:00
intro	Merge pull request #351 from 1ntrud3r/patch-1	2012-09-07 15:29:42 -07:00
man	Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review.	2012-04-08 21:13:32 +00:00
misc	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Merge pull request #333 from brad/ticket_18917	2012-09-07 12:00:01 -07:00
releases	Fixed minor typo in 1.3 release notes.	2012-09-06 21:00:16 +10:00
topics	Small reorganisation of initial parts of URL documentation.	2012-09-07 19:12:14 -04:00
Makefile	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00
README	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +00:00
conf.py	Added latex preamble for ≤.	2012-08-28 22:45:51 +02:00
contents.txt	Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch.	2010-12-27 23:58:16 +00:00
glossary.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	Fixed #17378 - Added a flattened index for class-based views.	2012-09-01 09:20:38 -04:00
make.bat	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx
documentation system [2].  This allows it to be built into other forms for
easier viewing and browsing.

To create an HTML version of the docs:

* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt.

The documentation in _build/html/index.html can then be viewed in a web browser.

[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx.pocoo.org/