django

History

Daniel Izquierdo 9a2b07f1b4 Fixed #20654 -- Fixed type of `m2m_changed`'s `pk_set` arg in docs		2013-06-25 09:46:17 +02:00
..
_ext	Replaced `and...or...` constructs with PEP 308 conditional expressions.	2013-05-26 23:47:50 -03:00
_theme/djangodocs	…
faq	…
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	…
ref	Fixed #20654 -- Fixed type of `m2m_changed`'s `pk_set` arg in docs	2013-06-25 09:46:17 +02:00
releases	Fixed #20653 -- Renamed checksetup management command.	2013-06-25 09:37:54 +08:00
topics	Clarified get_list_or_404 docs, refs #14150 .	2013-06-24 07:00:53 -04:00
Makefile	Allow build of translated documentation	2013-06-08 16:13:51 +02:00
README	…
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	…

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/