1
0
mirror of https://github.com/django/django.git synced 2024-11-18 23:44:22 +00:00
django/docs
2013-02-23 16:01:43 -05:00
..
_ext Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives 2013-02-09 09:16:10 -05:00
_theme/djangodocs Fixed #18789 - Fixed some text wrap issues with methods in the docs. 2013-02-19 10:25:26 -05:00
faq Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
howto Fixes typo introduced by django/django@08dc90bccf. This is described in Trac ticket:19855. 2013-02-19 17:03:33 -06:00
internals Some updates to "how to release Django": 2013-02-23 13:01:52 -06:00
intro Updated example to use staticfiles static template tag, thanks reinout for the suggestion, refs #19675. 2013-02-23 11:05:38 -05:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Fixed #19880 - Fixed an error in the form wizard initial_dict example. 2013-02-23 15:26:41 -05:00
releases Fixed #17906 - Autoescaping {% cycle %} and {% firstof %} templatetags. 2013-02-23 16:16:39 +01:00
topics Added an example of "default" database dictionary left blank; refs #19775. 2013-02-23 16:01:43 -05:00
conf.py Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives 2013-02-09 09:16:10 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Added more shortcuts to i18n docs in index page. 2013-01-25 13:50:37 -03:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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.pocoo.org/