django/docs
Christopher Medrela ac223ff6d1 Fixed #20735 -- clarified ManyToManyField constructor doc 2013-07-12 11:50:08 +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 Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Fixed #20493 -- Added a warning that objects may not be picklable across Django versions 2013-07-08 09:57:50 -04:00
internals Added some missing test requirements in the docs; refs #19196 2013-07-10 12:01:17 -04:00
intro Fixed #18261 -- Clarified 'project root directory' 2013-07-09 07:11:41 -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 Fixed #20735 -- clarified ManyToManyField constructor doc 2013-07-12 11:50:08 +02:00
releases Fixed #13721 -- Added UploadedFile.content_type_extra. 2013-07-11 09:11:59 -04:00
topics Fixed #17471 -- Added smtplib.SMTP_SSL connection option for SMTP backend 2013-07-11 22:00:08 +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 Updated test failure example. 2013-05-12 17:29:34 -03:00
make.bat

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/