1
0
mirror of https://github.com/django/django.git synced 2024-12-27 19:46:22 +00:00
django/docs
Daniel Roseman 4cc0baa98e [1.8.x] Fixed #25079 -- Added warning if both TEMPLATES and TEMPLATE_* settings are defined.
Django ignores the value of the TEMPLATE_* settings if TEMPLATES is also
set, which is confusing for users following older tutorials. This change
adds a system check that warns if any of the TEMPLATE_* settings have
changed from their defaults but the TEMPLATES dict is also non-empty.

Removed the TEMPLATE_DIRS from the test settings file; this was marked
for removal in 1.10 but no tests fail if it is removed now.

Backport of 24620d71f2 from master
2015-07-13 17:55:19 -04:00
..
_ext [1.8.x] Removed obsolete literals_to_xrefs.py script. 2015-06-15 13:01:32 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq [1.8.x] Simplified wording of Python support policy. 2015-06-22 12:20:20 -04:00
howto [1.8.x] Fixed typo in writing migrations docs 2015-07-01 09:17:10 +02:00
internals [1.8.x] Fixed #25056 -- Documented minimum version of jinja2 for testing. 2015-07-03 08:22:34 -04:00
intro [1.8.x] Removed a confusing sentence in tutorial 5. 2015-07-08 15:12:24 -04:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc
ref [1.8.x] Fixed #25079 -- Added warning if both TEMPLATES and TEMPLATE_* settings are defined. 2015-07-13 17:55:19 -04:00
releases [1.8.x] Fixed #25079 -- Added warning if both TEMPLATES and TEMPLATE_* settings are defined. 2015-07-13 17:55:19 -04:00
topics [1.8.x] Fixed #25082 -- Documented where to register system checks. 2015-07-10 10:38:38 -04:00
conf.py [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt [1.8.x] Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:44:07 -04:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist [1.8.x] Fixed #25059 -- Allowed Punycode TLDs in URLValidator 2015-07-06 15:11:43 -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/