django

mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00

History

James Bennett bc5716fc9c Added release date to 1.5 release notes. Forwardport of `61283a8208` from 1.5.x		2013-08-15 07:41:18 -04:00
..
_ext	Added a bugfix in docutils 0.11 -- docs will now build properly.	2013-07-31 09:24:29 -04:00
_theme/djangodocs	Fixed #18789 - Fixed some text wrap issues with methods in the docs.	2013-02-19 10:25:26 -05:00
faq	Fixed #19695 -- Retitle "Form Media" to "Form Assets".	2013-07-08 13:59:54 -04:00
howto	Fixed some ReST errors regarding backticks	2013-08-15 07:14:10 -04:00
internals	Updated docs following deprecation of django.views.defaults.shortcut	2013-08-15 00:27:16 +01:00
intro	Fixed some ReST errors regarding backticks	2013-08-15 07:14:10 -04:00
man
misc	Fixed #19728 - Updated API stability doc to reflect current meaning of "stable".	2013-02-19 18:19:50 -05:00
ref	Fixed some ReST errors regarding backticks	2013-08-15 07:14:10 -04:00
releases	Added release date to 1.5 release notes.	2013-08-15 07:41:18 -04:00
topics	Fixed some ReST errors regarding backticks	2013-08-15 07:14:10 -04:00
conf.py	Master is now pre-1.7.	2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt	Fixed #20766 -- Deprecated FastCGI support.	2013-07-24 13:41:45 -04:00
make.bat
Makefile	Allowed overriding variables in docs/Makefile.	2013-07-29 06:51:54 -04:00
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/