django

mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00

History

Russell Keith-Magee c41335fa27 Added backwards compatibliity checks to reference documentation.		2014-03-03 19:20:48 +08:00
..
_ext	Fixed #21869 -- Fixed docs building with Sphinx 1.2.1.	2014-01-24 08:52:43 -05:00
_theme	Fixed #21190 -- Added a new ePub theme for documentation.	2014-02-10 08:24:40 -05:00
faq	Django sees more than 1mm hits per hour	2013-12-31 16:23:20 -08:00
howto	Removed WSGI upgrade instructions for Django 1.3 and earlier.	2014-03-02 16:19:28 -05:00
internals	Fixed #22130 -- Deprecated fix_ampersands, removed utils.clean_html()	2014-03-01 14:07:57 +01:00
intro	Fixed some typos in the documentation.	2014-03-02 17:05:57 +01:00
man	Removed a man page for a command that was removed	2014-01-10 15:23:06 -08:00
misc	Fixed #16785 -- Documented some of the design decisions of the cache framework.	2014-01-16 21:13:08 -05:00
ref	Added backwards compatibliity checks to reference documentation.	2014-03-03 19:20:48 +08:00
releases	Fixed #22172 -- Allowed index_together to be a single list (rather than list of lists)..	2014-03-01 15:44:42 -05:00
topics	Fixed #22193 -- Made hint a truly optional arugment on check messages.	2014-03-03 19:16:19 +08:00
conf.py	Fixed #21190 -- Added a new ePub theme for documentation.	2014-02-10 08:24:40 -05:00
contents.txt	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07:00
glossary.txt	Fixed some typos in the documentation.	2014-03-02 17:05:57 +01:00
index.txt	Added first cut at reference documentation for the checks framework.	2014-03-03 18:56:11 +08:00
make.bat	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
Makefile	Allowed overriding variables in docs/Makefile.	2013-07-29 06:51:54 -04:00
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/