django/docs
Anderson Resende 2032bcf182 Fixed #26806 -- Triple quoted docstrings in docs/ref/forms/validation.txt. 2016-06-27 09:06:54 -04:00
..
_ext
_theme
faq
howto Fixed broken links in docs and comments. 2016-06-15 21:20:23 -04:00
internals Refs #17209 -- Added LoginView and LogoutView class-based views 2016-06-24 10:45:13 +02:00
intro
man
misc
ref Fixed #26806 -- Triple quoted docstrings in docs/ref/forms/validation.txt. 2016-06-27 09:06:54 -04:00
releases Fixed #5897 -- Added the Content-Length response header in CommonMiddleware 2016-06-27 10:44:57 +02:00
topics Fixed #26719 -- Normalized email in AbstractUser.clean(). 2016-06-24 10:37:38 -04:00
Makefile
README
conf.py
contents.txt
glossary.txt
index.txt
make.bat
spelling_wordlist Refs #26666 -- Added ALLOWED_HOSTS validation when running tests. 2016-06-20 11:07:46 -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/