django

History

Sébastien Fievet f36ab2d3f2 Fixed typo in docs/howto/custom-lookups.txt.		2014-09-07 11:29:20 +02:00
..
_ext	Added sphinx extension to ease generation of ticket links.	2014-08-19 17:40:50 -04:00
_theme	…
faq	…
howto	Fixed typo in docs/howto/custom-lookups.txt.	2014-09-07 11:29:20 +02:00
internals	Added the inaugural technical board.	2014-09-06 19:13:29 -04:00
intro	Fixed #23438 -- Added snippet & imports to docs/intro/overview.txt.	2014-09-06 07:31:36 -04:00
man	…
misc	…
ref	Fixed #23340 -- Corrected naturaltime docs to match behavior.	2014-09-06 07:47:56 -04:00
releases	Fixed #23416 -- Make sure DatabaseCreation respects checks.	2014-09-06 19:01:06 +01:00
topics	Fixed #22161 -- Documented send() with no recipients won't raise an exception.	2014-09-05 20:38:50 -04:00
Makefile	…
README	…
conf.py	Added sphinx extension to ease generation of ticket links.	2014-08-19 17:40:50 -04:00
contents.txt	…
glossary.txt	…
index.txt	…
make.bat	…
spelling_wordlist	Added words to spelling_wordlist.	2014-08-26 09:44:07 -04: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 ``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-doc.org/