django

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

History

Anubhav Joshi 1a9f13df59 Fixed #21478 -- Corrected docs for when Field.db_type() is called.		2013-12-19 19:29:07 +05:30
..
_ext	Fixed E127 pep8 warnings.	2013-12-14 11:59:15 -05:00
_theme/djangodocs	Fixed #21558 -- Support building CHM files.	2013-12-04 16:46:56 +01:00
faq	Updated a bunch of hyperlinks in documentation	2013-12-08 18:40:09 +01:00
howto	Fixed #21478 -- Corrected docs for when Field.db_type() is called.	2013-12-19 19:29:07 +05:30
internals	Removed usage of to-be-deprecated ADMIN_FOR setting in contributing docs	2013-12-14 16:49:25 +01:00
intro	Fixed link text for "Testing in Django" in tutorial 5.	2013-12-14 10:41:26 -05:00
man	Enabled makemessages to support several translation directories	2013-11-30 11:00:23 +01:00
misc	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
ref	Added some internal links to render_to_string documentation.	2013-12-15 23:02:20 +01:00
releases	Merge pull request #2079 from brutasse/master	2013-12-15 07:45:12 -08:00
topics	Added internal link to i18n documentation.	2013-12-15 01:50:54 +01:00
conf.py	Fixed all E261 warnings	2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt	Updated a bunch of hyperlinks in documentation	2013-12-08 18:40:09 +01:00
make.bat
Makefile
README	Whitespace cleanup.	2013-10-10 16:49:20 -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 ``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/