0
0
mirror of https://github.com/django/django.git synced 2024-11-22 11:57:34 +01:00
django/docs
2017-06-01 19:08:59 -04: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 Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
howto Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
internals Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
intro Added some shell output in tutorial 2. 2017-05-25 13:43:21 -04:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Fixed #27639 -- Added chunk_size parameter to QuerySet.iterator(). 2017-06-01 17:50:41 -04:00
releases Fixed #27639 -- Added chunk_size parameter to QuerySet.iterator(). 2017-06-01 17:50:41 -04:00
topics Fixed #22550 -- Prohibited QuerySet.last()/reverse() after slicing. 2017-05-31 19:34:56 -04:00
conf.py Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -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 Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:36:44 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -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
spelling_wordlist Fixed #28212 -- Allowed customizing the port that LiveServerTestCase uses. 2017-05-30 18:49:10 -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/