1
0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
django/docs
2013-03-13 14:16:27 -03:00
..
_ext Fixed creation of html docs on python 3. 2013-02-24 15:45:53 +01: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 Fixed #20026 -- Typo in Apache auth docs. 2013-03-11 22:48:03 +01:00
internals Proof-read and adjusted the transactions docs. 2013-03-13 15:17:41 +01:00
intro Fixed #19965 - Added a warning that the tutorial is written for Python 2. 2013-03-12 08:04:32 -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 broken link in binary fields doc. 2013-03-11 22:09:21 -03:00
releases Proof-read and adjusted the transactions docs. 2013-03-13 15:17:41 +01:00
topics Fixed an erroneous import in example code. 2013-03-13 14:16:27 -03:00
conf.py
contents.txt
glossary.txt
index.txt Deprecated django.contrib.comments. 2013-03-11 15:38:40 -05:00
make.bat
Makefile
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/