django

History

Alex Gaynor 6b560b50b9 Mark this as a python code-block		2013-10-29 07:26:06 -07:00
..
_ext	…
_theme/djangodocs	…
faq	…
howto	Fixed #20962 -- Documented that template tag render() may raise exceptions.	2013-10-14 11:53:15 -04:00
internals	Fix note syntax usage.	2013-10-27 08:06:36 -07:00
intro	Fixed indentation of example in tutuorial 2.	2013-10-22 08:10:56 -04:00
man	More migration docs, and conversion of all easy syncdb references	2013-07-25 16:19:36 +01:00
misc	…
ref	…
releases	Fixed typo in docs/releases/1.4.9.txt.	2013-10-25 07:55:05 -04:00
topics	…
Makefile	…
README	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
conf.py	Fixed E225 pep8 warnings.	2013-10-23 06:09:29 -04:00
contents.txt	…
glossary.txt	…
index.txt	…
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-doc.org/