1
0
mirror of https://github.com/django/django.git synced 2024-12-28 03:55:50 +00:00
django/docs
2014-04-18 16:11:04 -04:00
..
_ext
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq [1.7.x] Added Python 3.4 support notes. 2014-03-27 08:12:58 -04:00
howto [1.7.x] Moved RemoteUserBackend documentation to reference guide. 2014-04-18 16:11:04 -04:00
internals [1.7.x] Fixed #22444 -- Marked initial SQL/fixture loading as deprecated. 2014-04-17 20:37:25 -04:00
intro [1.7.x] Fixed #22472 -- Clarified meaning of dots in tutorial 4 code block. 2014-04-18 15:03:57 -04:00
man
misc
ref [1.7.x] Moved RemoteUserBackend documentation to reference guide. 2014-04-18 16:11:04 -04:00
releases [1.7.x] Added some missing items to the 1.6.3 release notes. 2014-04-18 10:32:49 -04:00
topics [1.7.x] Fixed #22471 -- Corrected misprint in i18n docs 2014-04-18 15:09:58 +02:00
conf.py Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist [1.7.x] Fixed spelling errors in documentation. 2014-04-16 09:39:25 -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/