django/docs
Aymeric Augustin cfcf4b3605 Stopped using django.utils.unittest in the test suite.
Refs #20680.
2013-07-01 14:29:33 +02: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 Bumped minimum Python version requirement to 2.7 in Django 1.7. 2013-07-01 12:01:59 +02:00
howto Add missing preposition in documentation 2013-06-26 10:25:34 -07:00
internals Fixed #20680 -- Deprecated django.utils.unittest. 2013-07-01 14:29:33 +02:00
intro Bumped minimum Python version requirement to 2.7 in Django 1.7. 2013-07-01 12:01:59 +02:00
man
misc
ref Fixed #20677 - Typos in generic_inlineformset_factory docs. 2013-06-29 14:14:32 -04:00
releases Fixed #20680 -- Deprecated django.utils.unittest. 2013-07-01 14:29:33 +02:00
topics Stopped using django.utils.unittest in the test suite. 2013-07-01 14:29:33 +02:00
Makefile Allow build of translated documentation 2013-06-08 16:13:51 +02:00
README
conf.py Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05: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/