django/docs
Tim Graham 5ae0dd6abf Fixed #25001 -- Doc'd caveat about collectstatic and removing INSTALLED_APPS.
Thanks aRkadeFR for the initial patch.
2015-06-22 12:36:38 -04:00
..
_ext Removed obsolete literals_to_xrefs.py script. 2015-06-15 10:22:18 -04:00
_theme Optimise the rest of the PNGs in docs 2015-05-29 15:22:40 +10:00
faq Simplified wording of Python support policy. 2015-06-22 12:07:53 -04:00
howto Added ALLOWED_HOSTS and SERVER_EMAIL details to deployment checklist. 2015-06-11 13:41:24 -04:00
internals Added Tomek Paczkowski bio to the team page 2015-06-19 17:20:54 +01:00
intro Removed support for Python 3.3. 2015-06-18 08:36:50 -04:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #25001 -- Doc'd caveat about collectstatic and removing INSTALLED_APPS. 2015-06-22 12:36:38 -04:00
releases Refs #25006 -- Added a '6 p.m.' option to the admin's time picker. 2015-06-22 07:24:57 -04:00
topics Fixed #14200 -- Added a fallback if HttpRequest.urlconf is None. 2015-06-20 18:52:33 -04: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 Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04: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 Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:41:39 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Added Tomek Paczkowski bio to the team page 2015-06-19 17:20:54 +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/