django

History

Collin Anderson db77915c9f Fixed E265 comment style		2015-02-06 09:30:35 -05:00
..
_ext	Fixed E265 comment style	2015-02-06 09:30:35 -05:00
_theme	…
faq	Removed compatibility with Python 3.2.	2015-01-17 09:00:17 -05:00
howto	Fixed #23932 -- Added how-to on migrating unique fields.	2015-02-05 16:26:45 -05:00
internals	Added cross references to contributing docs.	2015-02-05 10:40:46 -05: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	…
ref	Improved nested ArrayField example	2015-02-05 11:34:23 +01:00
releases	Fixed #6707 -- Added RelatedManager.set() and made descriptors' __set__ use it.	2015-02-05 12:45:08 +07:00
topics	Removed inaccurate sentence about PO files in translation docs.	2015-02-06 07:45:05 -05:00
Makefile	…
README	…
conf.py	Fixed E265 comment style	2015-02-06 09:30:35 -05:00
contents.txt	…
glossary.txt	…
index.txt	Added a "Writing migrations" how-to.	2015-02-03 13:09:54 -05:00
make.bat	…
spelling_wordlist	Added "SQL" to doc wordlist.	2015-02-04 22:12:41 -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/