django/docs
Carl Meyer 3ed0b6ed64 Fixed #17799 - Documented that the execute() method of a management command is not suitable for calling the command from code; call_command should be used instead. Thanks kacah222 for the report and claudep for the patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17629 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-02 17:13:53 +00:00
..
_ext
_theme/djangodocs
faq Fixed #17129 - Model FAQ: Link to south 2011-11-01 22:27:02 +00:00
howto Fixed #17799 - Documented that the execute() method of a management command is not suitable for calling the command from code; call_command should be used instead. Thanks kacah222 for the report and claudep for the patch. 2012-03-02 17:13:53 +00:00
internals Refs #17800 - Added release notes and deprecation note about SECRET_KEY requirement. 2012-03-02 04:04:56 +00:00
intro Fixed #17715 -- Updated the tutorial for time zone support, plus a few other improvements. 2012-02-26 21:17:58 +00:00
man
misc Fixed many more ReST indentation errors, somehow accidentally missed from [16955] 2011-10-14 00:12:01 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #17799 - Documented that the execute() method of a management command is not suitable for calling the command from code; call_command should be used instead. Thanks kacah222 for the report and claudep for the patch. 2012-03-02 17:13:53 +00:00
releases Fixed 17764. Improved auth docs. 2012-03-02 05:03:52 +00:00
topics Fixed #17046 -- Added a check if the username passed to User.objects.create_user is empty or not. Thanks, kwadrat. 2012-03-02 16:56:20 +00:00
Makefile
README
conf.py
contents.txt Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch. 2010-12-27 23:58:16 +00:00
glossary.txt
index.txt
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_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/