django

mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00

History

David Cramer 27f68f8659 Correct scoping of savepoint example		2014-12-20 12:02:26 -08:00
..
_ext	Fixed #23968 -- Replaced list comprehension with generators and dict comprehension	2014-12-08 07:58:23 -05:00
_theme
faq	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
howto	Updated some other external links in the docs	2014-12-19 18:07:52 +01:00
internals	Updated some other external links in the docs	2014-12-19 18:07:52 +01:00
intro	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
man
misc
ref	Fixed #2443 -- Added DurationField.	2014-12-20 18:28:29 +00:00
releases	Fixed #2443 -- Added DurationField.	2014-12-20 18:28:29 +00:00
topics	Correct scoping of savepoint example	2014-12-20 12:02:26 -08:00
conf.py	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
contents.txt
glossary.txt
index.txt	Updated formtools docs to point at new package outside the Django repo.	2014-11-26 09:41:52 -05:00
make.bat
Makefile	Added an "htmlview" target to open docs after building them.	2014-12-08 07:23:34 -05:00
README
spelling_wordlist	Added words to docs wordlist.	2014-12-19 14:37:06 -05: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/