django/docs
Carl Meyer e35c70bef4 Fixed #23892 -- Clarified compatibility policy for migrations. 2015-02-16 10:11:47 -05:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Removed compatibility with Python 3.2. 2015-01-17 09:00:17 -05:00
howto Deprecated TEMPLATE_DEBUG setting. 2015-02-15 20:47:04 +01:00
internals Deprecated TEMPLATE_DEBUG setting. 2015-02-15 20:47:04 +01:00
intro Added cross references to contributing docs. 2015-02-05 10:40:46 -05:00
man Removed gather_profile_stats.py 2015-02-06 07:58:31 -05:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Deprecated TEMPLATE_DEBUG setting. 2015-02-15 20:47:04 +01:00
releases Deprecated TEMPLATE_DEBUG setting. 2015-02-15 20:47:04 +01:00
topics Fixed #23892 -- Clarified compatibility policy for migrations. 2015-02-16 10:11:47 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Fixed E265 comment style 2015-02-06 09:30:35 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Added a "Writing migrations" how-to. 2015-02-03 13:09:54 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Fixed #24325 -- Documented change in ModelForm.save() foreign key access. 2015-02-14 08:08:05 -05:00

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 ``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-doc.org/