django/docs
Jannis Leidel 7478aeb0a7 Fixed #15705 -- Added Croatian (hr) localflavor. Thanks, Zlatko Mašek and Julien Phalip.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16077 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-04-22 12:03:42 +00:00
..
_ext Reformated some code for readability. 2010-11-20 21:00:41 +00:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Fixed a comma splice in docs/faq/install.txt from [16004] 2011-04-02 21:49:39 +00:00
howto Fixed #15822 -- Removed references to the v1 postgresql backend (which has been removed). Thanks for the patch, aaugustin 2011-04-17 20:45:06 +00:00
internals Updated the contributing document to accurately reflect our security process. 2011-04-17 14:13:19 +00:00
intro Fixed #15257 - Add a link about field lookups to the tutorial; thanks dwillis. 2011-02-22 00:57:28 +00:00
man Fixed #7735 -- Added support for IPv6 adresses to runserver and testserver management command. Thanks to Jason Alonso and Łukasz Rekucki for the report and initial patches. 2010-11-26 13:33:53 +00:00
misc Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt 2011-04-01 16:10:22 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #15705 -- Added Croatian (hr) localflavor. Thanks, Zlatko Mašek and Julien Phalip. 2011-04-22 12:03:42 +00:00
releases Added note about HTML5 to release notes. 2011-04-21 00:00:32 +00:00
topics Fixed #15794 -- Corrected an error in the docs which indicated applying decorators to any of the view-like methods would work when it will only work reliably with dispatch. 2011-04-20 20:03:42 +00:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
README Added a README for building offline HTML docs. 2010-11-06 17:44:26 +00:00
conf.py Bumped django_next_version so that "New in Django 1.3" links appear correctly. 2011-03-24 09:40:50 +00: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 Minor markup and organization fixes to docs to correct Sphinx errors. 2011-03-22 14:35:14 +00:00
index.txt Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt 2011-04-01 16:10:22 +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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` 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/