django1

History

Adrian Holovaty d694f17536 Made some small edits to localization docs from [17690] git-svn-id: http://code.djangoproject.com/svn/django/trunk@17693 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-03-12 23:05:16 +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	Fixed #17842 - Typo in uWsgi docs; thanks mitnk.	2012-03-10 10:03:33 +00:00
internals	Made some small edits to localization docs from [17690]	2012-03-12 23:05:16 +00:00
intro	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +00:00
man	Fixed a couple of minor errors in the django-admin(1) Unix man page.	2012-02-06 02:00:19 +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 some docs and docstrings until [17685]	2012-03-12 20:05:48 +00:00
releases	Added note to releases/1.4.txt about contrib.auth user password hash-upgrade sequence. Thanks, ericholscher	2012-03-12 20:14:58 +00:00
topics	Edited some docs and docstrings until [17685]	2012-03-12 20:05:48 +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 #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +00:00
conf.py	Bump for 1.4 RC 1.	2012-03-05 17:22:23 +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

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:

* 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/