1
0
mirror of https://github.com/django/django.git synced 2025-01-08 17:37:20 +00:00
django/docs
2017-09-03 12:05:18 -04:00
..
_ext [1.11.x] Removed usage of deprecated sphinx.util.compat.Directive. 2017-05-24 10:45:12 -04:00
_theme [1.11.x] Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:56 -04:00
faq [1.11.x] Fixed #27855 -- Updated docs for Python 3.4 support in Django 2.0. 2017-08-11 11:18:09 -04:00
howto [1.11.x] Fixed #28367 -- Doc'd how to override management commands. 2017-09-02 16:39:07 -04:00
internals [1.11.x] Fixed #27655 -- Added some guidelines to the coding style docs. 2017-06-12 15:39:25 -04:00
intro [1.11.x] Refs #23276 -- Fixed explanation of how calling views works. 2017-08-31 12:00:32 -04:00
man [1.11.x] Updated man page for Django 1.11. 2017-04-04 11:53:56 -04:00
misc [1.11.x] Updated various links in docs to avoid redirects 2017-05-22 19:32:02 +02:00
ref [1.11.x] Fixed #17985 -- Documented ModelAdmin.lookup_allowed(). 2017-09-02 14:09:49 -04:00
releases [1.11.x] Fixed #28550 -- Restored contrib.auth's login() and logout() views' respect of positional arguments. 2017-09-03 12:05:18 -04:00
topics [1.11.x] Fixed #28332 -- Fixed diamond inheritence example in docs. 2017-09-02 14:33:19 -04:00
conf.py [1.11.x] Fixed docs build with Sphinx 1.6. 2017-05-24 09:47:24 -04:00
contents.txt
glossary.txt
index.txt [1.11.x] Refs #17453 -- Fixed broken link to #django IRC logs. 2017-07-21 18:11:02 -04:00
make.bat
Makefile [1.11.x] Fixed docs build with Sphinx 1.6. 2017-05-24 09:47:24 -04:00
README
spelling_wordlist [1.11.x] Fixed #28548 -- Replaced 'middlewares' with 'middleware' in docs. 2017-08-30 06:26:04 -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/