django/docs
Marti Raudsepp 11d453bcad Various documentation typo/spelling fixes
Errors detected by Topy (https://github.com/intgr/topy), all changes
verified by hand.
2014-04-23 02:31:49 +03:00
..
_ext
_theme
faq Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Fixed queries that may return unexpected results on MySQL due to typecasting. 2014-04-21 18:11:26 -04:00
internals Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03:00
intro Fixed #22472 -- Clarified meaning of dots in tutorial 4 code block. 2014-04-18 12:10:46 -04:00
man Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc
ref Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03:00
releases Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03:00
topics Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03:00
Makefile
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
spelling_wordlist Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03: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-doc.org/