django/docs
Tim Graham b0ab74dfca Added stub release notes for security releases. 2015-08-18 08:03:39 -04:00
..
_ext
_theme Added white-space: pre-wrap; to docs code blocks to match docs.dp.com. 2015-06-22 15:56:06 -04:00
faq Updated various links in docs 2015-08-08 13:57:15 +02:00
howto Removed unnecessary comma in docs 2015-08-10 16:02:14 +02:00
internals Updated various links in docs 2015-08-08 13:57:15 +02:00
intro Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
man
misc Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
ref Limited line length in docs/ref/contrib/messages.txt example. 2015-08-17 07:44:04 -04:00
releases Added stub release notes for security releases. 2015-08-18 08:03:39 -04:00
topics Updated memcached library links to point to PyPI. 2015-08-11 21:20:32 -04:00
Makefile
README
conf.py
contents.txt
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt
make.bat
spelling_wordlist Refs #25236 -- Discouraged use of ifequal/ifnotequal template tags. 2015-08-08 08:23:33 -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/