0
0
mirror of https://github.com/django/django.git synced 2024-11-29 06:03:25 +01:00
django/docs
2014-04-06 17:33:43 -04:00
..
_ext
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Fixed #22218 -- Deprecated django.conf.urls.patterns. 2014-04-03 07:28:10 -04:00
internals Fixed #21977 -- Deprecated SimpleTestCase.urls 2014-04-06 17:33:43 -04:00
intro Fixed #22218 -- Deprecated django.conf.urls.patterns. 2014-04-03 07:28:10 -04:00
man
misc
ref Fixed #22216 -- Added Form.non_field_errors to form API doc. 2014-04-05 18:16:01 -04:00
releases Fixed #21977 -- Deprecated SimpleTestCase.urls 2014-04-06 17:33:43 -04:00
topics Fixed #21977 -- Deprecated SimpleTestCase.urls 2014-04-06 17:33:43 -04:00
conf.py Bumped version to reflect master is now pre-1.8. 2014-03-21 06:17:14 -04: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 Fixed #22218 -- Deprecated django.conf.urls.patterns. 2014-04-03 07:28:10 -04:00

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/