1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Akshesh 156e2d59cf Fixed #26709 -- Added class-based indexes.
Added the AddIndex and RemoveIndex operations to use them in migrations.

Thanks markush, mjtamlyn, timgraham, and charettes for review and advice.
2016-06-27 10:41:01 -04:00
..
_ext
_theme
faq
howto Fixed broken links in docs and comments. 2016-06-15 21:20:23 -04:00
internals Refs #17209 -- Added LoginView and LogoutView class-based views 2016-06-24 10:45:13 +02:00
intro Fixed #26747 -- Used more specific assertions in the Django test suite. 2016-06-16 14:19:18 -04:00
man
misc
ref Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
releases Fixed #5897 -- Added the Content-Length response header in CommonMiddleware 2016-06-27 10:44:57 +02:00
topics Added missing trailing '$' to url() patterns in docs. 2016-06-27 09:18:44 -04:00
conf.py Ignored new warnings when building the docs with Sphinx 1.4. 2016-06-01 11:03:41 -04:00
contents.txt
glossary.txt
index.txt Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
Makefile
README
spelling_wordlist Refs #26666 -- Added ALLOWED_HOSTS validation when running tests. 2016-06-20 11:07:46 -04:00

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/