django/docs
James Beith 75ec064808 [1.9.x] Fixed a typo in the managers docs.
Backport of e03798a4ae from master
2015-11-27 13:53:49 -05:00
..
_ext [1.9.x] Fixed #23751 -- Fixed code snippet formatting in docs PDF. 2015-11-16 20:32:07 -05:00
_theme [1.9.x] Made doc icon's edges smooth. 2015-11-14 08:12:23 -05:00
faq [1.9.x] Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:46 -05:00
howto [1.9.x] Fixed #25526 -- Documented how to output colored text in custom management commands. 2015-11-17 18:24:10 -05:00
internals [1.9.x] Corrected outdated information in submitting patches guide. 2015-11-16 10:00:20 -05:00
intro [1.9.x] Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:46 -05:00
man [1.9.x] Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:32:28 -04:00
misc [1.9.x] Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:46 -05:00
ref [1.9.x] Fixed man page by ensuring ".pot" doesn't render unescaped. 2015-11-25 17:23:13 -05:00
releases [1.9.x] Added Scottish Gaelic as new available language 2015-11-27 09:59:50 +01:00
topics [1.9.x] Fixed a typo in the managers docs. 2015-11-27 13:53:49 -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 [1.9.x] Refs #23751 -- Added some unicode characters to the latex preamble. 2015-11-16 20:32:17 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt [1.9.x] Changed section title from "Model syntax" to "Introduction to models". 2015-11-16 09:54:25 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.9.x] Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:32:28 -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 ``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/