1
0
mirror of https://github.com/django/django.git synced 2025-03-24 08:10:45 +00:00
Russell Keith-Magee 24582f18ff [1.5.x] Fixed #19218 -- Added documentation note on limitations of signals with custom User models.
Thanks to kunitoki@gmail.com for the report.

Backport of fdb5c98d7ee54c7f89ec10b0203263f1f5b37510.
2012-11-24 14:27:11 +08: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 ``sudo 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.pocoo.org/