django/docs
2016-05-06 08:26:20 -04:00
..
_ext [1.9.x] Fixed #23868 -- Added support for non-unique django-admin-options in docs. 2016-02-01 11:25:42 -05:00
_theme [1.9.x] Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:49:03 -05:00
faq [1.9.x] Changed gypsy to manouche in docs and tests. 2016-02-03 09:48:01 -05:00
howto [1.9.x] Fixed code example in docs/howto/custom-lookups.txt 2016-05-06 08:26:20 -04:00
internals [1.9.x] Fixed #26554 -- Updated docs URLs to readthedocs.io 2016-04-28 10:15:23 -04:00
intro [1.9.x] Fixed #26554 -- Updated docs URLs to readthedocs.io 2016-04-28 10:15:23 -04:00
man [1.9.x] Discouraged use of /tmp with predictable names. 2015-12-24 09:56:54 -05:00
misc [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
ref [1.9.x] Normalized "an SQL" spelling. 2016-05-03 19:31:07 -04:00
releases [1.9.x] Fixed #26558 -- Removed need for request context processor on admin login page. 2016-05-04 09:48:17 -04:00
topics [1.9.x] Normalized "an SQL" spelling. 2016-05-03 19:31:07 -04:00
conf.py [1.9.x] Fixed #26554 -- Updated docs URLs to readthedocs.io 2016-04-28 10:15:23 -04:00
contents.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
glossary.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
index.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -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
spelling_wordlist [1.9.x] Fixed #26267 -- Fixed BoundField to reallow slices of subwidgets. 2016-02-24 07:03:24 -05:00

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/