1
0
mirror of https://github.com/django/django.git synced 2025-01-10 18:36:05 +00:00
django/docs
2014-07-21 19:54:22 +00:00
..
_ext [1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-07 07:25:02 -04:00
_theme [1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-07 07:25:02 -04:00
faq [1.7.x] Fixed #22880 -- Added FAQ entry about UnicodeDecodeError 2014-06-24 09:03:06 +02:00
howto [1.7.x] Fixed #22809 -- Added model Field API reference. 2014-07-10 06:05:05 -04:00
internals [1.7.x] Replaced instances of 'his/her' with 'their'. 2014-07-21 19:54:22 +00:00
intro [1.7.x] Edited setup.py in reuseable apps tutorial to use a context manager for open(). 2014-07-16 14:26:04 -04:00
man
misc
ref [1.7.x] Replaced instances of 'his/her' with 'their'. 2014-07-21 19:54:22 +00:00
releases [1.7.x] Added 1.6.6 release notes for #22998 (also forwardported those for #13794). 2014-07-16 13:35:41 -04:00
topics [1.7.x] Replaced instances of 'his/her' with 'their'. 2014-07-21 19:54:22 +00:00
conf.py [1.7.x] Fixed several typos in Django 2014-05-29 07:53:02 -04:00
contents.txt
glossary.txt
index.txt [1.7.x] Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:13:24 -04:00
make.bat
Makefile
README
spelling_wordlist [1.7.x] Fixed #22796 -- Added a more basic explanations of forms. 2014-06-24 14:58:53 -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/