django/docs
mlavin ac46eb7e83 [1.8.x] Fixed #25231 -- Added recording of squashed migrations in the migrate command.
Ensured squashed migrations are recorded as applied when the
migrate command is run and all of the original migrations
have been previously applied.

Backport of 69db1c7455 from master
2015-08-07 18:16:37 -04:00
..
_ext [1.8.x] Removed obsolete literals_to_xrefs.py script. 2015-06-15 13:01:32 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq [1.8.x] Simplified wording of Python support policy. 2015-06-22 12:20:20 -04:00
howto [1.8.x] Fixed #25207 -- Misspelled word in documentation: dialogue 2015-08-01 19:18:10 -04:00
internals [1.8.x] Improved link to the supported versions section of the download page. 2015-07-31 12:27:18 -04:00
intro [1.8.x] Fixed #25161 -- Encouraged users to install the latest release in docs 2015-07-24 13:36:44 -04:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.8.x] Fixed #25213 -- Discouraged use of QuerySet.extra() 2015-08-05 08:15:44 -04:00
releases [1.8.x] Fixed #25231 -- Added recording of squashed migrations in the migrate command. 2015-08-07 18:16:37 -04:00
topics [1.8.x] Fixed #25229 -- Clarified how an iterable works with @permission_required 2015-08-05 17:18:13 -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 [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -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 [1.8.x] Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:44:07 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.8.x] Fixed #25059 -- Allowed Punycode TLDs in URLValidator 2015-07-06 15:11:43 -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/