0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
2013-06-24 13:59:03 +10:00
..
_ext Replaced and...or... constructs with PEP 308 conditional expressions. 2013-05-26 23:47:50 -03:00
_theme/djangodocs Fixed #18789 - Fixed some text wrap issues with methods in the docs. 2013-02-19 10:25:26 -05:00
faq Fixed #15201: Marked CACHE_MIDDLEWARE_ANONYMOUS_ONLY as deprecated 2013-05-18 17:38:32 +02:00
howto Fixed #20634 - Corrected doc mistake re: staticfiles finders strategy. 2013-06-21 14:57:12 -04:00
internals Fixed #20524 - Described keywords in triaging contrib doc. 2013-06-23 15:41:24 -04:00
intro Fixed error in last commit. Thanks Simon Charette. 2013-06-20 10:41:29 -04:00
man
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Added missing versionadded for FormMixin.prefix. 2013-06-22 16:49:24 -04:00
releases Fixed #18872 -- Added prefix to FormMixin 2013-06-22 12:12:43 +01:00
topics Corrected minor typos in FileUploadHandler.receive_data_chunk docs. 2013-06-24 13:59:03 +10:00
conf.py Allow build of translated documentation 2013-06-08 16:13:51 +02:00
contents.txt
glossary.txt
index.txt Updated test failure example. 2013-05-12 17:29:34 -03:00
make.bat
Makefile Allow build of translated documentation 2013-06-08 16:13:51 +02:00
README

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

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/