django

mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00

History

Tim Graham 8905fcbda6 Fixed #22526 -- Added note about check() method to 1.7 release notes. Thanks kevin-brown for the report.		2014-04-27 14:17:37 -04:00
..
_ext
_theme
faq	Added Python 3.4 support notes.	2014-03-27 08:01:33 -04:00
howto	Specified 'csv and unicode' note as Python 2 only	2014-04-26 16:09:19 +02:00
internals	Fixed #3214 -- Stopped parsing SQL with regex.	2014-04-26 17:46:23 +02:00
intro	Updated doc links to point to Python 3 documentation	2014-04-26 16:02:53 +02:00
man	Fixed #22328 -- Added --exclude option to compilemessages and makemessages.	2014-04-26 17:07:44 +07:00
misc
ref	Documented django.setup().	2014-04-26 20:13:59 +02:00
releases	Fixed #22526 -- Added note about check() method to 1.7 release notes.	2014-04-27 14:17:37 -04:00
topics	Updated doc links to point to Python 3 documentation	2014-04-26 16:02:53 +02:00
conf.py	Updated doc links to point to Python 3 documentation	2014-04-26 16:02:53 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile	Fixed #22141 -- Added a spelling checker for documentation.	2014-03-07 09:29:23 -05:00
README
spelling_wordlist	Various documentation typo/spelling fixes	2014-04-23 02:31:49 +03: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-doc.org/