django

mirror of https://github.com/django/django.git synced 2025-08-20 02:30:24 +00:00

History

Danilo Bargen 276332d85c [1.6.x] Fixed #23543 -- Added docs on testing management command output. Backport of `cdee865976` from master		2014-11-24 10:29:24 -05:00
..
_ext	[1.6.x] Added sphinx extension to ease generation of ticket links.	2014-08-19 17:47:21 -04:00
_theme/djangodocs	[1.6.x] Removed duplicate "Deprecated in Django A.B" text in docs.	2014-06-07 07:27:13 -04:00
faq	[1.6.x] Used link label in models FAQ to ease translation	2014-05-22 09:48:36 +02:00
howto	[1.6.x] Fixed #23543 -- Added docs on testing management command output.	2014-11-24 10:29:24 -05:00
internals	[1.6.x] Added sphinx extension to ease generation of ticket links.	2014-08-19 17:47:21 -04:00
intro	[1.6.x] Replaced dead links to python-distribute.org.	2014-10-24 18:59:21 -04:00
man
misc	[1.6.x] Fixed #21213 -- Added docs for Django's mailing lists.	2013-12-19 09:24:13 -05:00
ref	[1.6.x] Added missing backticks to form validation docs	2014-11-20 11:10:09 -05:00
releases	[1.6.x] Better migration docs for get_query_set -> get_queryset	2014-11-24 10:13:17 +00:00
topics	[1.6.x] Fixed #23543 -- Added docs on testing management command output.	2014-11-24 10:29:24 -05:00
conf.py	[1.6.x] Added sphinx extension to ease generation of ticket links.	2014-08-19 17:47:21 -04:00
contents.txt
glossary.txt	[1.6.x] Fixed some intersphinx references.	2014-10-16 20:10:59 -04:00
index.txt	[1.6.x] Fixed #21213 -- Added docs for Django's mailing lists.	2013-12-19 09:24:13 -05:00
make.bat
Makefile
README

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 ``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.pocoo.org/