django

mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00

History

Tim Graham 3631db88cb Fixed typo in form wizard docs.		2012-08-19 20:13:09 -04:00
..
_ext	Made more extensive usage of context managers with open.	2012-05-05 14:06:36 +02:00
_theme/djangodocs	Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.	2010-07-24 10:21:21 +00:00
faq	Moved a note about django-admin.py errors from Tutorial Part 1 to a new FAQ Troubleshooting page. This is to avoid confusion for beginners.	2012-08-04 17:27:57 -07:00
howto	[py3] Ported django.utils.safestring.	2012-08-18 16:04:06 +02:00
internals	Removed missplaced label in the docs.	2012-08-12 12:43:05 +02:00
intro	Added a warning about the {% url %} syntax change	2012-08-18 09:58:42 +02:00
man	Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review.	2012-04-08 21:13:32 +00:00
misc	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
obsolete	Fixed #14141 : docs now use the :doc: construct for links between documents.	2010-08-19 19:27:44 +00:00
ref	Fixed typo in form wizard docs.	2012-08-19 20:13:09 -04:00
releases	Fixed #17228 -- params context variable is inconsistent	2012-08-18 15:07:21 +01:00
topics	Fixed #17180 - Emphasized the need to load the i18n template tag in each template that uses translations. Thanks stefan.freyr for the suggestion and buddylindsey for the draft patch.	2012-08-19 18:46:46 -04:00
conf.py	Fixed #18698 -- Configure latex to support '≥' in the docs.	2012-08-11 21:48:11 +02:00
contents.txt	Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch.	2010-12-27 23:58:16 +00:00
glossary.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	And link security policies from documentation index.	2012-08-07 16:26:37 -04:00
make.bat	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00
Makefile	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00
README	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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/