django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Thomas Chaumeny 8fb7a0987c Fixed a typo in 1.8 release notes.		2015-01-09 07:38:11 -05: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	Fixed #24020 -- Refactored SQL compiler to use expressions	2015-01-08 14:07:54 -05:00
internals	Fixed #12663 -- Formalized the Model._meta API for retrieving fields.	2015-01-06 19:25:12 -05:00
intro	Deprecated TEMPLATE_DIRS.	2014-12-28 17:02:30 +01:00
man	Fixed #18714 -- Added 'fuzzy' compilemessages option	2014-11-18 22:44:16 +01:00
misc
ref	Fixed #24020 -- Refactored SQL compiler to use expressions	2015-01-08 14:07:54 -05:00
releases	Fixed a typo in 1.8 release notes.	2015-01-09 07:38:11 -05:00
topics	Fixed #24083 -- Corrected is_bound nature in forms topic docs	2015-01-06 08:56:53 +01:00
conf.py	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
contents.txt
glossary.txt
index.txt	Fixed #24070 -- Added tutorial topics to doc index.	2015-01-03 08:48:31 -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 'loopback' to spelling word list.	2015-01-06 20:02:03 -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/