p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
django/docs
History
Tim Graham 65bff161ff [1.8.x] Fixed #25618 -- Added a helpful error message when Django & south migrations exist in the same directory. 2015-10-28 09:59:32 -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] Documented Python 3.5 support for Django 1.8. 2015-10-25 06:02:21 -04:00
howto [1.8.x] Fixed #25515 -- Documented the return value of BaseCommand.handle() 2015-10-06 15:09:58 -04:00
internals [1.8.x] Updated references to the TEST_* database settings. 2015-09-05 20:31:22 +02:00
intro [1.8.x] Clarified that the test client response content attribute is bytes. 2015-10-23 14:27:15 -04: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] Fixed #25434 -- Documented HttpRequest.site and created a section for middleware attributes. 2015-10-24 09:59:36 -04:00
releases [1.8.x] Fixed #25618 -- Added a helpful error message when Django & south migrations exist in the same directory. 2015-10-28 09:59:32 -04:00
topics [1.8.x] Fixed #25397 -- Documented class-based view context variable clash with context processors. 2015-10-23 15:24:18 -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 "readded" to the docs wordlist. 2015-09-21 17:08:27 -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/