1
0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
django/docs
Adrian Holovaty 442ab475c8 Edited deployment doc changes from [17338]
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17421 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-02-03 17:51:14 +00:00
..
_ext Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed 2012-01-11 10:19:05 +00:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Fixed #17129 - Model FAQ: Link to south 2011-11-01 22:27:02 +00:00
howto Edited deployment doc changes from [17338] 2012-02-03 17:51:14 +00:00
internals Updated my bio. 2012-01-25 16:43:52 +00:00
intro Fixed #17538 -- corrected the section in tutorial 3 about the handler404 default. Thanks matt at brozowski dot com for the report. 2012-01-12 22:03:34 +00:00
man Fixed #17042 -- Extended startproject and startapp management commands to better handle custom app and project templates. Many thanks to Preston Holmes for his initial patch and Alex Gaynor, Carl Meyer, Donald Stufft, Jacob Kaplan-Moss and Julien Phalip for code reviewing. 2011-12-22 22:38:02 +00:00
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 Edited models/options.txt changes from [17314] 2012-02-03 17:45:28 +00:00
releases Fixed #16921 -- Added assertHTMLEqual and assertHTMLNotEqual assertions, and converted Django tests to use them where appropriate. Thanks Greg Müllegger. 2012-01-31 20:36:11 +00:00
topics Fixed #16921 -- Added assertHTMLEqual and assertHTMLNotEqual assertions, and converted Django tests to use them where appropriate. Thanks Greg Müllegger. 2012-01-31 20:36:11 +00:00
conf.py Bump to 1.4 alpha 1. 2011-12-23 04:00:26 +00:00
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 Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
index.txt Fixed #16277 -- Changed the link to the IRC logs. 2011-11-25 19:40:46 +00:00
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
README Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00

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/