django

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

History

Tim Graham 660c30ed95 Fixed #16965 -- Clarified Formset can_delete docs. Thanks gregcorey@ for the suggestion.		2013-07-08 12:08:30 -04:00
..
_ext	Replaced `and...or...` constructs with PEP 308 conditional expressions.	2013-05-26 23:47:50 -03:00
_theme/djangodocs	Fixed #18789 - Fixed some text wrap issues with methods in the docs.	2013-02-19 10:25:26 -05:00
faq	Bumped minimum Python version requirement to 2.7 in Django 1.7.	2013-07-01 12:01:59 +02:00
howto	Fixed #20493 -- Added a warning that objects may not be picklable across Django versions	2013-07-08 09:57:50 -04:00
internals	Clarified trac patch-related field meaning	2013-07-07 21:17:10 -07:00
intro	Fixed #20224 -- Update docs examples which mention __unicode__	2013-07-05 19:27:07 +02:00
man	Revert "Patch by Claude for #16084."	2013-01-25 13:58:37 -03:00
misc	Fixed #19728 - Updated API stability doc to reflect current meaning of "stable".	2013-02-19 18:19:50 -05:00
ref	Fixed #12346 -- Added a note on how to validate InlineFormSets.	2013-07-08 08:29:28 -04:00
releases	fixed grammar	2013-07-04 12:31:58 -07:00
topics	Fixed #16965 -- Clarified Formset can_delete docs.	2013-07-08 12:08:30 -04:00
conf.py	Master is now pre-1.7.	2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt	Updated test failure example.	2013-05-12 17:29:34 -03:00
make.bat	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
Makefile	Allow build of translated documentation	2013-06-08 16:13:51 +02: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/