django

History

Marc Tamlyn d7aa0bd802 We should branch after the first beta. We did this for 1.6 and it was very effective. 95%+ of fixes which merge during the alpha are backported, as the policy is "all but really major features". It's easier to just not merge any really major features. After beta, we have feature freeze so we need to backport bugs to stable but not features, so then the branch makes sense.		2014-01-23 20:07:14 +00:00
..
_ext	Fixed E127 pep8 warnings.	2013-12-14 11:59:15 -05:00
_theme/djangodocs	Fixed #21558 -- Support building CHM files.	2013-12-04 16:46:56 +01:00
faq	Django sees more than 1mm hits per hour	2013-12-31 16:23:20 -08:00
howto	Always use parentheses when documenting a method with no arguments.	2014-01-22 22:26:10 +01:00
internals	We should branch after the first beta.	2014-01-23 20:07:14 +00:00
intro	Fixed #16905 -- Added extensible checks (nee validation) framework	2014-01-20 10:45:21 +08: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	Fixed #21864 -- Fixed missing quote in custom lookup example.	2014-01-23 16:13:20 +01:00
releases	Fixed #21861 -- Fixed typo in 1.7 release notes.	2014-01-23 09:29:09 -05:00
topics	Fixed #21847 -- Clarified where ContactForm was defined	2014-01-23 13:48:09 -05:00
Makefile	Allowed overriding variables in docs/Makefile.	2013-07-29 06:51:54 -04:00
README	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
conf.py	Pointed intersphinx links to Python's default version.	2013-12-30 19:09:45 +01: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	Fixed #16905 -- Added extensible checks (nee validation) framework	2014-01-20 10:45:21 +08:00
make.bat	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05: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/