django/docs
Tim Graham 0f7b5b38b6 [2.0.x] Fixed #28796 -- Doc'd backwards incompatibility when reverse() receives bytestring args/kwargs.
Due to 301de774c2.

Backport of 6bf85ff7e3 from master
2017-11-16 09:29:50 -05:00
..
_ext Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
_theme Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:30 -04:00
faq Fixed #27855 -- Updated docs for Python 3.4 support in Django 2.0. 2017-08-11 11:17:08 -04:00
howto [2.0.x] Fixed 'a'/'an' mix-ups in docs. 2017-10-30 21:47:27 -04:00
internals [2.0.x] Fixed #28759 -- Promoted the contributing guide in the docs for the django-developers mailing list. 2017-11-01 20:39:28 -04:00
intro Fixed #28593 -- Added a simplified URL routing syntax per DEP 0201. 2017-09-20 18:04:42 -04:00
man [2.0.x] Updated man page for Django 2.0 alpha. 2017-09-22 12:26:46 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [2.0.x] Fixed #28786 -- Doc'd middleware ordering considerations due to CommonMiddleware setting Content-Length. 2017-11-14 12:57:18 -05:00
releases [2.0.x] Fixed #28796 -- Doc'd backwards incompatibility when reverse() receives bytestring args/kwargs. 2017-11-16 09:29:50 -05:00
topics [2.0.x] Fixed #28770 -- Warned that quoting a placeholder in a raw SQL string is unsafe. 2017-11-07 13:07:29 -05:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [2.0.x] Bumped django_next_version in docs config. 2017-09-22 12:21:21 -04:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Refs #17453 -- Fixed broken link to #django IRC logs. 2017-07-21 18:09:48 -04:00
make.bat
spelling_wordlist Fixed #14370 -- Allowed using a Select2 widget for ForeignKey and ManyToManyField in the admin. 2017-09-18 13:48:02 -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/