django1/docs
Aymeric Augustin cc14d51ee8 Fixed #24704 -- Made the autoreloader survive SyntaxErrors.
With this change, it's expected to survive anything except errors
that make it impossible to import the settings. It's too complex
to fallback to a sensible behavior with a broken settings module.

Harcoding things about runserver in ManagementUtility.execute is
atrocious but it's the only way out of the chicken'n'egg problem:
the current implementation of the autoreloader primarily watches
imported Python modules -- and then a few other things that were
bolted on top of this design -- but we want it to kick in even if
the project contains import-time errors and django.setup() fails.

At some point we should throw away this code and replace it by an
off-the-shelf autoreloader that watches the working directory and
re-runs `django-admin runserver` whenever something changes.

Backport of fe6ddb837d from master
2015-08-29 23:12:08 +02: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] Updated Wikipedia links to use https 2015-08-08 12:09:53 +02:00
howto [1.8.x] Removed unnecessary comma in docs 2015-08-10 10:20:51 -04:00
internals [1.8.x] Used consistent capitalization and hyphenation of "class-based views" in docs. 2015-08-18 19:08:08 -04:00
intro [1.8.x] Updated Wikipedia links to use https 2015-08-08 12:09:53 +02:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.8.x] Refs #2495 -- Documented that MySQL cannot have TextField(unique=True). 2015-08-27 09:30:29 -04:00
releases Fixed #24704 -- Made the autoreloader survive SyntaxErrors. 2015-08-29 23:12:08 +02:00
topics [1.8.x] Fixed #25311 -- Removed vague language about "partial commits" from docs. 2015-08-25 20:24:05 -04:00
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
conf.py [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt [1.8.x] Updated Wikipedia links to use https 2015-08-08 12:09:53 +02: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 Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.8.x] Added 'subtransactions' to spelling wordlist. 2015-08-26 08:24:19 -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/