django/docs
Marissa Zhou 8b1f39a727 Fixed #24796 -- Added a hint on placement of SecurityMiddleware in MIDDLEWARE_CLASSES.
Also moved it in the project template.
2015-06-08 12:32:38 -04:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme Optimise the rest of the PNGs in docs 2015-05-29 15:22:40 +10:00
faq Removed Django 1.6 from the Python version chart. 2015-04-02 14:21:01 -04:00
howto Fixed #24882 -- Documented Migration.run_before 2015-06-06 09:00:04 -04:00
internals Capitalized "Python" in docs. 2015-06-05 08:24:53 -04:00
intro Fixed #24907 -- Updated contributing tutorial with a more recent example ticket. 2015-06-06 08:36:50 -04:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #24796 -- Added a hint on placement of SecurityMiddleware in MIDDLEWARE_CLASSES. 2015-06-08 12:32:38 -04:00
releases Moved jQuery to a vendor/jquery subdirectory. 2015-06-07 22:23:42 +02:00
topics Fixed #24796 -- Added a hint on placement of SecurityMiddleware in MIDDLEWARE_CLASSES. 2015-06-08 12:32:38 -04: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 #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Fixed #24732 -- Reordered tutorial to cover basics before bells and whistles. 2015-05-28 14:07:39 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Fixed #24907 -- Updated contributing tutorial with a more recent example ticket. 2015-06-06 08:36:50 -04: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/