django

History

Ben Firshman 8160e6341d Fix "semicolon" in docs		2013-07-02 17:52:54 +01:00
..
_ext	Replaced `and...or...` constructs with PEP 308 conditional expressions.	2013-05-26 23:47:50 -03:00
_theme/djangodocs	…
faq	Bumped minimum Python version requirement to 2.7 in Django 1.7.	2013-07-01 12:01:59 +02:00
howto	Add missing preposition in documentation	2013-06-26 10:25:34 -07:00
internals	Deprecated django.utils.dictconfig.	2013-07-01 22:50:58 +02:00
intro	Bumped minimum Python version requirement to 2.7 in Django 1.7.	2013-07-01 12:01:59 +02:00
man	…
misc	Fixed #19728 - Updated API stability doc to reflect current meaning of "stable".	2013-02-19 18:19:50 -05:00
ref	Reflected the new default value of LOGGING_CONFIG in docs.	2013-07-01 23:16:25 +02:00
releases	Deprecated django.utils.dictconfig.	2013-07-01 22:50:58 +02:00
topics	Fix "semicolon" in docs	2013-07-02 17:52:54 +01:00
Makefile	Allow build of translated documentation	2013-06-08 16:13:51 +02:00
README	…
conf.py	Master is now pre-1.7.	2013-06-28 08:56:45 -05:00
contents.txt	…
glossary.txt	…
index.txt	Updated test failure example.	2013-05-12 17:29:34 -03:00
make.bat	…

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/