django

History

Tim Graham 349471eeb9 Fixed spelling errors in docs.		2014-10-28 10:15:52 -04:00
..
_ext	Added sphinx extension to ease generation of ticket links.	2014-08-19 17:40:50 -04:00
_theme	Added newlines to the ends of CSS, HTML, and JavaScript files missing them.	2014-08-12 19:22:09 -04:00
faq	Fixed #23527 -- Removed Cheetah references in docs	2014-09-21 18:03:31 +02:00
howto	…
internals	Fixed spelling errors in docs.	2014-10-28 10:15:52 -04:00
intro	…
man	Replaced django-admin.py with django-admin in the man page.	2014-07-31 23:46:49 +02:00
misc	Fixed #16785 -- Documented some of the design decisions of the cache framework.	2014-01-16 21:13:08 -05:00
ref	Fixed spelling errors in docs.	2014-10-28 10:15:52 -04:00
releases	Fixed #23606 -- Implemented Client and RequestFactory trace() methods.	2014-10-28 10:11:12 -04:00
topics	Fixed #23606 -- Implemented Client and RequestFactory trace() methods.	2014-10-28 10:11:12 -04:00
Makefile	…
README	…
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	…
make.bat	…
spelling_wordlist	Fixed spelling errors in docs.	2014-10-28 10:15:52 -04: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 ``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/