django

mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00

History

Alex Gaynor c347f78cc1 Fixed all E226 violations		2013-11-03 10:08:55 -08:00
..
_ext	Fixed all E226 violations	2013-11-03 10:08:55 -08:00
_theme/djangodocs	Fixed #20910 -- Added a "snippet" sphinx directive to allow prefixing a filename.	2013-10-14 13:00:57 -04:00
faq	Fixed #8918 -- Made FileField.upload_to optional.	2013-10-11 08:07:25 -04:00
howto	Fixed #20962 -- Documented that template tag render() may raise exceptions.	2013-10-14 11:53:15 -04:00
internals	Fix note syntax usage.	2013-10-27 08:06:36 -07:00
intro	Fixed indentation of example in tutuorial 2.	2013-10-22 08:10:56 -04:00
man
misc	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
ref	Django should be capitalized in text	2013-11-02 20:15:40 +01:00
releases	Django should be capitalized in text	2013-11-02 20:15:40 +01:00
topics	Fixed #21373 -- Typo fixed in i18n docs	2013-11-02 19:13:29 +01:00
conf.py	Fixed all E261 warnings	2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt	Fixed #21213 -- Added docs for Django's mailing lists.	2013-10-04 10:00:36 -04: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/