django/docs
Justin Bronn db3f07f4c3 Update link to use GEOS 3.4.2 in source installation docs. 2015-04-13 13:57:00 -04:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Removed Django 1.6 from the Python version chart. 2015-04-02 14:21:01 -04:00
howto Fixed typo in docs/howto/deployment/wsgi/apache-auth.txt 2015-04-13 07:50:23 -04:00
internals I'm back in Texas. 2015-04-13 13:42:26 -04:00
intro Fixed typo in docs/intro/tutorial02.txt 2015-04-07 07:41:05 -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 Update link to use GEOS 3.4.2 in source installation docs. 2015-04-13 13:57:00 -04:00
releases Fixed #24611 -- Fixed update() crash with related UUID pk object. 2015-04-13 12:18:24 -04:00
topics Fixed #24621 -- Fixed and documented SessionBase.pop's second argument 2015-04-13 10:32:03 -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 #23814 -- Documented apps refactored out of Django. 2015-03-25 08:46:23 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Refs #24568 -- Added Read the Docs step to the release checklist. 2015-04-09 10:07:20 -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/