django/docs
Tim Graham d5a109f6e6 Fixed #23802 -- Typos in 1.7 release notes. 2014-11-13 20:10:02 +01:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Fixed #23527 -- Removed Cheetah references in docs 2014-09-21 18:03:31 +02:00
howto Fixed versionchanged indentation in docs/. 2014-11-03 21:40:26 -05:00
internals Fixed #23775 -- Added docs for --bisect and --pair runtests options. 2014-11-12 20:46:34 +01:00
intro Replaced dead links to python-distribute.org. 2014-10-24 18:58:31 -04:00
man Replaced django-admin.py with django-admin in the man page. 2014-07-31 23:46:49 +02:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Added missing docs for 1_7.W001 check. 2014-11-13 17:56:29 +01:00
releases Fixed #23802 -- Typos in 1.7 release notes. 2014-11-13 20:10:02 +01:00
topics Removed thread customizations of six which are now built-in. 2014-11-13 10:30:53 +01:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03: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 Moved CSRF docs out of contrib. 2014-11-03 07:47:39 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Fixed spelling errors in docs. 2014-11-11 16:41:09 +01: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/