1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2013-02-28 08:25:14 -05: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
howto Fixes typo introduced by django/django@08dc90bccf. This is described in Trac ticket:19855. 2013-02-19 17:03:33 -06:00
internals Added a Trac-related item to the release checklist. 2013-02-28 10:26:47 +01:00
intro Made a small clarification in tutorial. 2013-02-23 19:07:06 -08:00
man
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Refactored database exceptions wrapping. 2013-02-27 17:26:54 +01:00
releases 1.5 is no longer "UNDER DEVELOPMENT". 2013-02-28 11:11:26 +01:00
topics Fixed #19937 - Typo in class-based views intro. 2013-02-28 08:25:14 -05:00
conf.py
contents.txt
glossary.txt
index.txt
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/