django

mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00

History

Tim Graham 1708c8afb6 Merge pull request #1053 from makto/patch-1 Fixed #20394 - Clarified argument of get_user in docs		2013-05-13 11:02:30 -07:00
..
_ext	Adapted uses of versionchanged/versionadded to the new form.	2013-04-20 17:18:35 +02: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 #15379 - Added "how to cite Django" to FAQ.	2013-03-29 16:48:07 -04:00
howto	Fixed #20215 -- Disabled persistent connections by default.	2013-05-09 15:42:14 +02:00
internals	Fixed #17365 , #17366 , #18727 -- Switched to discovery test runner.	2013-05-10 23:08:45 -04:00
intro	Fixed #20249 - Removed a "feature" in the tutorial that doesn't actually work.	2013-05-11 19:08:57 -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 #20397 - Cleaned up issue with quotation marks in documentation	2013-05-12 20:24:48 +01:00
releases	Fixed #17365 , #17366 , #18727 -- Switched to discovery test runner.	2013-05-10 23:08:45 -04:00
topics	Merge pull request #1053 from makto/patch-1	2013-05-13 11:02:30 -07:00
conf.py	Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives	2013-02-09 09:16:10 -05:00
contents.txt
glossary.txt
index.txt	Updated test failure example.	2013-05-12 17:29:34 -03: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/