django/docs
Carl Meyer 08fbbaa45b Deprecated calling a SQLCompiler instance. 2014-11-18 19:47:16 -07:00
..
_ext
_theme
faq
howto Fixed #20435 -- Reordered the custom template tags docs. 2014-11-17 17:38:04 +01:00
internals Deprecated calling a SQLCompiler instance. 2014-11-18 19:47:16 -07:00
intro Fixed #23855 -- Removed unnecessary all() in tutorial 3. 2014-11-17 18:10:50 +01:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc
ref Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
releases Deprecated calling a SQLCompiler instance. 2014-11-18 19:47:16 -07:00
topics Fix malformed note directives. 2014-11-17 16:42:54 -07:00
Makefile
README
conf.py Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Fixed #14030 -- Allowed annotations to accept all expressions 2014-11-15 14:00:43 +00:00
make.bat
spelling_wordlist Fixed spelling errors in docs. 2014-11-11 16:41:09 +01: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 ``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/