django/docs
Goetz 39b49fd339 Fixed #21101 -- Updated urlize documentation to mention email addresses 2013-09-13 12:42:06 -04:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs Fixed #18789 - Fixed some text wrap issues with methods in the docs. 2013-02-19 10:25:26 -05:00
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Fix broken sphinx reference to staticfiles. 2013-09-10 22:10:00 +02:00
internals Documentation -- added instructions on working with pull requests 2013-09-13 08:26:46 -04:00
intro Fixed #21094 -- Updated reuseable apps tutorial to use pip for installation. 2013-09-13 09:29:21 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Fixed #21101 -- Updated urlize documentation to mention email addresses 2013-09-13 12:42:06 -04:00
releases Fixed #21100 -- Noted that Create/UpdateViews.fields is new in 1.6 2013-09-13 09:34:12 -04:00
topics Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH. 2013-09-11 08:17:15 -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 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 Consolidated documentation for F() and Q() 2013-09-06 12:57:25 -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/