mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
Code Issues 25 Releases Wiki Activity
62865b4cde
django/docs
History
Russell Keith-Magee 62865b4cde Fixed #15527 -- Added a explanatory note about the SQL debug log. Thanks to boxm for the report, and jpaulett for the draft patch 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15897 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-03-22 23:18:09 +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 Minor markup and organization fixes to docs to correct Sphinx errors. 2011-03-22 14:35:14 +00:00
howto Tweaked title level in custom file storage systems documentation. 2011-03-21 15:39:26 +00:00
internals Update release notes and other docs for impending 1.3. 2011-03-22 06:57:12 +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 Fixed #14455 -- Documented the backwards compatibility policy for local flavors. Implemented the policy for the changes in the Indonesian local flavor (from r14195) that stimulated the development of this policy. Thanks to Karen, Alex, Ramiro and Chris for their help developing the policy. 2010-11-01 00:52:58 +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 typo in forms API documentation. 2011-03-22 23:16:22 +00:00
releases Corrected a number of mislinked crossrefs and added a few new crossref targets found in/via the 1.3 release. 2011-03-22 20:12:17 +00:00
topics Fixed #15527 -- Added a explanatory note about the SQL debug log. Thanks to boxm for the report, and jpaulett for the draft patch 2011-03-22 23:18:09 +00:00
conf.py Fixed #15196 -- Bumped version up a bit in Sphinx configuration. Thanks, Eric Holscher. 2011-01-30 20:31:39 +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 Fixed #6181 - Document django.views.decorators.http - thanks adamv for the patch. 2010-12-27 13:27:26 +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

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/