django/docs
Tim Graham ff5e47e7a4 Corrected sqlmigrate output in tutorial 1. 2015-02-22 12:29:01 -05:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme
faq
howto Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
internals Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
intro Corrected sqlmigrate output in tutorial 1. 2015-02-22 12:29:01 -05:00
man Removed gather_profile_stats.py 2015-02-06 07:58:31 -05:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
releases Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
topics Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
Makefile
README
conf.py Fixed E265 comment style 2015-02-06 09:30:35 -05:00
contents.txt
glossary.txt
index.txt
make.bat
spelling_wordlist Fixed #24325 -- Documented change in ModelForm.save() foreign key access. 2015-02-14 08:08:05 -05: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/