django/docs
Tim Graham a8f05f405f Replaced "inbuilt" with more common "built-in". 2015-11-12 17:29:03 -05:00
..
_ext
_theme Made doc icons background transparent. 2015-11-11 11:37:28 -05:00
faq Added Django 1.10 to Python version support table. 2015-10-26 10:28:53 -04:00
howto Revised Windows install instructions for Python 3.5. 2015-10-21 20:25:57 -04:00
internals Fixed #25550 -- Deprecated direct assignment to the reverse side of a related set. 2015-10-27 07:57:15 -04:00
intro Optimized docs images and documented the process. 2015-10-24 14:57:21 -04:00
man Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:31:11 -04:00
misc Fixed #25732 -- Updated template system design philosophy. 2015-11-11 11:49:51 -05:00
ref Replaced "inbuilt" with more common "built-in". 2015-11-12 17:29:03 -05:00
releases Replaced "inbuilt" with more common "built-in". 2015-11-12 17:29:03 -05:00
topics Fixed #25169 -- Documented stacking of permission_required and login_required. 2015-11-12 14:23:59 -05:00
Makefile
README
conf.py
contents.txt
glossary.txt
index.txt Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:41:39 -04:00
make.bat
spelling_wordlist Added "subpath" to spelling wordlist. 2015-10-22 15:01:33 -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/