django

mirror of https://github.com/django/django.git synced 2024-11-30 23:20:50 +01:00

History

Adrian Holovaty 72efdc4d92 Merge pull request #436 from ddbeck/patch-1 Removed heteronormativity from coding style doc		2012-10-15 07:45:27 -07: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 #19006 - Quoted filenames in Content-Disposition header.	2012-10-03 17:44:56 -04:00
internals	Merge pull request #436 from ddbeck/patch-1	2012-10-15 07:45:27 -07:00
intro	Fixed #18807 -- Made 404.html and 500.html optional	2012-09-30 23:16:19 +02:00
man
misc	Replaced mentions of Subversion by Git in docs	2012-10-14 23:03:01 +02:00
ref	Added ref to format localization in Date[Time]Field docs	2012-10-13 11:17:25 +02:00
releases	Added release note about removed div around csrf token	2012-10-13 21:01:30 +02:00
topics	Fixed #19067 -- Clarified handling of username in createsuperuser.	2012-10-13 13:36:07 +08:00
conf.py	Added latex preamble for ≤.	2012-08-28 22:45:51 +02: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/