mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-26 19:16:11 +00:00
Code Issues 27 Releases Wiki Activity
ae5b662796
django/docs
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 Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
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 Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
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 Bumped version to reflect master is now pre-1.8. 2014-03-21 06:17:14 -04:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
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/