django/docs
Carl Meyer bd669e47d7 Added a note about creating new doc versions; update stable doc version before announcement. 2013-02-26 14:46:46 -07: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 note about creating new doc versions; update stable doc version before announcement. 2013-02-26 14:46:46 -07:00
intro Made a small clarification in tutorial. 2013-02-23 19:07:06 -08: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 #19801 - Added brackets to input_formats. 2013-02-25 12:22:02 -05:00
releases Merge pull request #835 from vdboor/docfix 2013-02-24 12:11:55 -08:00
topics Fixed #19922 - Typo in translation docs. 2013-02-26 15:12:28 -05:00
Makefile
README
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
make.bat

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/