django

mirror of https://github.com/django/django.git synced 2024-12-24 18:16:19 +00:00

History

Simon Charette 6293eaa062 Fixed #20159 -- Mispelled attribute in multi-db documentation example. Thanks to sane4ka.sh at gmail for the report!		2013-03-29 14:16:30 -04:00
..
_ext	Fixed spelling errors	2013-03-28 11:16:53 -06: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 #15363 -- Renamed and normalized to `get_queryset` the methods that return a QuerySet.	2013-03-08 10:11:45 -05:00
howto	Added missing markup to docs.	2013-03-22 13:50:07 -04:00
internals	Minor updates to 'How is Django Formed.'	2013-03-28 15:31:05 -06:00
intro	Fix minor typo in tutorial	2013-03-23 09:55:24 +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	Improved FormView docs in class-based views index.	2013-03-29 07:57:07 -04:00
releases	Added 1.5.1 release notes.	2013-03-28 15:03:19 -05:00
topics	Fixed #20159 -- Mispelled attribute in multi-db documentation example.	2013-03-29 14:16:30 -04: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	Deprecated django.contrib.comments.	2013-03-11 15:38:40 -05:00
make.bat	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
Makefile	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05: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/