django

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

History

Aymeric Augustin 43d7cee86e Added release notes for 1.6. Since 1.5 is feature-frozen, we need them to document new features.		2012-10-30 21:35:23 +01:00
..
_ext
_theme/djangodocs
faq	Fixed #11460 - Added a FAQ regarding missing rows in the admin.	2012-09-27 17:36:02 -04:00
howto	Fixed #19208 -- Docs for mod_wsgi daemon mode	2012-10-29 21:39:12 +01:00
internals	Fixed #18978 -- Moved cleanup command to sessions.	2012-10-27 18:31:00 +02:00
intro	Fixed #19180 - Clarified policy regarding older versions of the docs.	2012-10-25 17:55:42 -04:00
man
misc	Replaced mentions of Subversion by Git in docs	2012-10-14 23:03:01 +02:00
ref	Fixed #19209 -- Documented \|date:"I".	2012-10-29 23:12:20 +01:00
releases	Added release notes for 1.6.	2012-10-30 21:35:23 +01:00
topics	Fixed #19061 -- added is_active attribute to AbstractBaseUser	2012-10-28 23:04:03 -07:00
conf.py	Ensure that version detection in docs from `373df56d` uses the right Django copy.	2012-10-28 18:18:09 -03:00
contents.txt	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07:00
glossary.txt
index.txt	Fixed two broken links introduced in recent commits.	2012-09-27 17:33:52 -04:00
make.bat
Makefile
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/