django/django
1
1
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-26 13:41:05 +03:00
Code Issues Packages Projects Releases Wiki Activity
1b961e8ee3
django/docs
History
Timo Graham 1b961e8ee3 Fixed #15153 - removed obsolete sentence in tutorial; thanks LeSphinx for the report. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15313 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-01-26 00:58:41 +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 #10904 -- Corrected inappropriate usage of the term "absolute URL" throughout the docs. Replaced with the (RFC 2396-compliant) terms "absolute path reference" or "absolute path" as appropriate for the context. Thanks to sharan666 for the report, and Malcolm, Chris, and dwillis for their work in supplying a solution and patch. 2010-11-07 01:42:55 +00:00
howto Refs #14661 -- Clarified the handling of initial data injected via custom SQL. 2011-01-18 16:43:01 +00:00
internals Rationalised CompatCookie/SimpleCookie into single SimpleCookie class with all fixes. 2011-01-24 20:35:46 +00:00
intro Fixed #15153 - removed obsolete sentence in tutorial; thanks LeSphinx for the report. 2011-01-26 00:58:41 +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 #14038 -- Added information to release notes and version changed|added markers to documentation additions for the new template loeaders API introduced in version 1.2. Thanks 3point2 for the report. 2011-01-25 15:42:24 +00:00
releases Fixed #14038 -- Added information to release notes and version changed|added markers to documentation additions for the new template loeaders API introduced in version 1.2. Thanks 3point2 for the report. 2011-01-25 15:42:24 +00:00
topics Fixed #15163 - typo in email docs; thanks metal for the report. 2011-01-26 00:37:08 +00:00
conf.py Removed compatibility with Sphinx < 1.0 workarounds in our extension code. Also, started to use the 'needs_sphinx' Sphinx config var. 2010-11-19 23:19:56 +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 Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +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/