1
0
mirror of https://github.com/django/django.git synced 2024-12-26 19:16:11 +00:00
django/docs
Tim Graham c139e3e0a0 [1.7.x] Fixed #21858 -- Clarified 1.6 release note regarding M2M help text changes.
Thanks lee at semel.net for the report.

Backport of f30e6590f4 from master
2014-03-29 10:23:23 -04:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq [1.7.x] Added Python 3.4 support notes. 2014-03-27 08:12:58 -04:00
howto [1.7.x] Fixed #22322 -- Fixed incorrect explanation of what managed=False does. 2014-03-25 14:03:02 -04:00
internals [1.7.x] Add some syncdb deprecation stuff into the deprecation doc 2014-03-25 20:02:07 -04:00
intro Substituted 'shortcut function' for 'factory method' in tutorial 2014-03-09 14:07:39 -07:00
man Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.7.x] Fixed #21941 -- Documented the kwargs param of django.conf.urls.url(). 2014-03-27 07:02:02 -04:00
releases [1.7.x] Fixed #21858 -- Clarified 1.6 release note regarding M2M help text changes. 2014-03-29 10:23:23 -04:00
topics [1.7.x] Fixed #21941 -- Documented the kwargs param of django.conf.urls.url(). 2014-03-27 07:02:02 -04:00
conf.py Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
spelling_wordlist Updated spelling_wordlist. 2014-03-11 08:11:16 -04:00

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 ``sudo 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/