p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
Tim Graham 6f8e655ca0 [1.6.x] Added release note stubs for 1.5.6 and 1.4.11. 
Backport of dfa28981ce from master
 		2014-01-26 17:49:01 -05:00
..
_ext [1.6.x] Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 09:05:49 -05:00
_theme/djangodocs [1.6.x] Fixed #21558 -- Support building CHM files. 2013-12-04 16:51:37 +01:00
faq [1.6.x] Django sees more than 1mm hits per hour 2013-12-31 19:42:45 -05:00
howto [1.6.x] Always use parentheses when documenting a method with no arguments. 2014-01-22 23:00:06 +01:00
internals [1.6.x] Fixed #21824 -- Added reference to LTS in docs/internals/security.txt 2014-01-24 08:14:41 -05:00
intro [1.6.x] Fixed #21834 -- Clarifed usage of template_name in tutorial part 4. 2014-01-20 20:06:08 -05:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc [1.6.x] Fixed #21213 -- Added docs for Django's mailing lists. 2013-12-19 09:24:13 -05:00
ref [1.6.x] Fixed some punctuation; thanks Chris Jerdonek. 2014-01-23 09:05:09 -05:00
releases [1.6.x] Added release note stubs for 1.5.6 and 1.4.11. 2014-01-26 17:49:01 -05:00
topics [1.6.x] Fixed typo. Refs #21836. 2014-01-26 09:30:27 +01:00
Makefile [1.6.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:42 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py [1.6.x] Fixed #21213 -- Added docs for Django's mailing lists. 2013-12-19 09:24:13 -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 [1.6.x] Fixed #21213 -- Added docs for Django's mailing lists. 2013-12-19 09:24:13 -05: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.pocoo.org/