1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Tim Graham ee4043f735 Refs #28593 -- Moved django.conf.urls.include() to django.urls().
The old location remains for backwards compatibility. Documentation
will be updated separately along with the rest of the URL routing changes.
2017-09-13 16:32:03 -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 Fixed #27855 -- Updated docs for Python 3.4 support in Django 2.0. 2017-08-11 11:17:08 -04:00
howto Fixed #28367 -- Doc'd how to override management commands. 2017-09-02 16:21:13 -04:00
internals Fixed #28579 -- Doc'd upgrade effort expectations for Django 2.0. 2017-09-11 09:07:14 -04:00
intro Refs #23276 -- Fixed explanation of how calling views works. 2017-08-31 11:57:46 -04:00
man
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Refs #28593 -- Moved django.conf.urls.include() to django.urls(). 2017-09-13 16:32:03 -04:00
releases Refs #27090 -- Added real database sequence introspection. 2017-09-13 20:12:32 +02:00
topics Removed obsolete doc references to javascript_catalog. 2017-09-08 07:53:56 -04:00
conf.py Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
contents.txt
glossary.txt
index.txt Refs #17453 -- Fixed broken link to #django IRC logs. 2017-07-21 18:09:48 -04:00
make.bat
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README
spelling_wordlist Fixed capitalization of "Spherical Mercator." 2017-09-09 09:35:30 -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/