django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Preston Holmes c8eff0dbcb Fixed #19562 -- cleaned up password storage docs		2013-01-04 18:02:10 -08:00
..
_ext
_theme/djangodocs	Fixed #19317 - Added an image for warning blocks in the docs	2012-11-22 06:34:15 -05:00
faq	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
howto	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
internals	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
intro	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
man
misc	Removed django.contrib.localflavor.	2012-12-29 21:59:06 +01:00
ref	Added documentation for the 'db' argument of the post-syncdb signal.	2013-01-03 22:04:55 +01:00
releases	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
topics	Fixed #19562 -- cleaned up password storage docs	2013-01-04 18:02:10 -08:00
conf.py	Fixed broken links, round 3. refs #19516	2012-12-26 19:07:22 -05:00
contents.txt	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07:00
glossary.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	Removed django.contrib.localflavor.	2012-12-29 21:59:06 +01:00
make.bat	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
Makefile	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
README	Fixed #18928 . Tightened language in docs/README.	2012-09-08 11:11:37 +05:30

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.pocoo.org/