django

History

minusf 70c080fcdb Misc doc cleanups.		2013-07-29 06:57:33 -04:00
..
_ext	Replaced `and...or...` constructs with PEP 308 conditional expressions.	2013-05-26 23:47:50 -03:00
_theme/djangodocs	…
faq	Fixed #19695 -- Retitle "Form Media" to "Form Assets".	2013-07-08 13:59:54 -04:00
howto	Fixed a number of minor misspellings.	2013-07-27 18:46:03 -07:00
internals	Fixed #20766 -- Deprecated FastCGI support.	2013-07-24 13:41:45 -04:00
intro	Fixed #20763 -- Typo in tutorial 3.	2013-07-18 07:58:51 -04:00
man	Revert "Patch by Claude for #16084."	2013-01-25 13:58:37 -03:00
misc	…
ref	Misc doc cleanups.	2013-07-29 06:57:33 -04:00
releases	Moved a release note that I had accidentally misplaced in `bb145e2c47`.	2013-07-27 19:52:59 -07:00
topics	Misc doc cleanups.	2013-07-29 06:57:33 -04:00
Makefile	Allowed overriding variables in docs/Makefile.	2013-07-29 06:51:54 -04:00
README	Fixed #18928 . Tightened language in docs/README.	2012-09-08 11:11:37 +05:30
conf.py	Master is now pre-1.7.	2013-06-28 08:56:45 -05:00
contents.txt	…
glossary.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	Fixed #20766 -- Deprecated FastCGI support.	2013-07-24 13:41:45 -04:00
make.bat	…

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/