django/docs
Tim Graham d823bb790d Fixed #17156 -- Added documentation examples for exists()
Thanks mrmagooey for the draft patch.
2012-09-08 11:19:49 -04:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs
faq Avoided mixing dates and datetimes in the examples. 2012-09-08 11:00:04 -04:00
howto Fixed #15566 - Documented that update() doesn't honor DateField.auto_now 2012-09-08 06:38:41 -04:00
internals Fixed #18647 - Removed link to Malcolm's blog which is gone. 2012-08-30 07:44:41 -04:00
intro Avoided mixing dates and datetimes in the examples. 2012-09-08 11:00:04 -04:00
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete
ref Fixed #17156 -- Added documentation examples for exists() 2012-09-08 11:19:49 -04:00
releases Fixed minor typo in 1.3 release notes. 2012-09-06 21:00:16 +10:00
topics Avoided mixing dates and datetimes in the examples. 2012-09-08 11:00:04 -04:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Added latex preamble for ≤. 2012-08-28 22:45:51 +02:00
contents.txt
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Fixed #17378 - Added a flattened index for class-based views. 2012-09-01 09:20:38 -04:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00: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/