django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Tim Graham ae5b662796 Added a note regarding django.contrib.auth.authenticate. Thanks Josh Brown for the suggestion.		2014-04-16 07:47:56 -04:00
..
_ext
_theme
faq	Added Python 3.4 support notes.	2014-03-27 08:01:33 -04:00
howto	Added RemoteUserMiddleware to middleware reference page.	2014-04-16 07:22:15 -04:00
internals	Fixed #22401 -- Deprecated regular expression parsing of initial SQL in favor of installing sqlparse.	2014-04-09 19:25:07 -04:00
intro	Added Python 3.4 to list of supported version in docs/intro/install.txt	2014-04-08 11:13:05 -04:00
man
misc
ref	Added RemoteUserMiddleware to middleware reference page.	2014-04-16 07:22:15 -04:00
releases	Fixed #22369 -- Added count parameter to assertTemplateUsed	2014-04-14 15:55:10 -04:00
topics	Added a note regarding django.contrib.auth.authenticate.	2014-04-16 07:47:56 -04:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist	Fixed some spelling issues in docs.	2014-04-08 10:08:25 -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 ``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-doc.org/