django/docs
Kenneth Kam e83aba0e2c Fixed #23762 -- clarified CACHE_MIDDLEWARE_ANONYMOUS_ONLY deprecation in docs 2015-02-23 09:23:07 -05:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Removed compatibility with Python 3.2. 2015-01-17 09:00:17 -05:00
howto Broke long lines in code examples. 2015-02-23 07:45:37 -05:00
internals Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
intro Updated tutorial to use explicit relative imports. 2015-02-22 14:20:02 -05:00
man Removed gather_profile_stats.py 2015-02-06 07:58:31 -05:00
misc
ref Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
releases Fixed #23762 -- clarified CACHE_MIDDLEWARE_ANONYMOUS_ONLY deprecation in docs 2015-02-23 09:23:07 -05:00
topics Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Fixed E265 comment style 2015-02-06 09:30:35 -05:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Added a "Writing migrations" how-to. 2015-02-03 13:09:54 -05:00
make.bat
spelling_wordlist Added formats for the Azerbaijani locale. 2015-02-23 07:37:13 -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/