django/docs
Marco Santamaria 1e0bf2cab9 [1.8.x] Fixed #11078 -- Removed inaccurate docs about proxy models Meta.
Backport of bae72bdd2a from master
2015-04-20 09:17:28 -04:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -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 [1.8.x] Removed Django 1.6 from the Python version chart. 2015-04-02 14:22:29 -04:00
howto [1.8.x] Fixed typo in docs/howto/deployment/wsgi/apache-auth.txt 2015-04-13 07:51:08 -04:00
internals [1.8.x] Removed docs for removed transaction APIs. 2015-04-14 13:53:18 -04:00
intro [1.8.x] Fixed typo in docs/intro/tutorial02.txt 2015-04-07 07:41:46 -04:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.8.x] Removed DateTimeQuerySet from docs. 2015-04-18 10:14:38 -04:00
releases [1.8.x] Fixed typo in docs/releases/1.8.1.txt 2015-04-17 11:25:55 -04:00
topics [1.8.x] Fixed #11078 -- Removed inaccurate docs about proxy models Meta. 2015-04-20 09:17:28 -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 [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -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 [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.8.x] Reverted "Fixed #24325 -- Documented change in ModelForm.save() foreign key access." 2015-02-24 11:51:10 -05: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/