mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 16 Releases Wiki Activity
django/docs
History
James Bennett bd83177c70 Correct a typo in [14541]. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14542 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 		2010-11-12 16:35:40 +00:00
..
_ext Fixed hyperlinking of template tags/filters in offline docs so that non-builtin tags/filters are not hyperlinked to a page where no docs for them exist 2010-11-06 17:42:21 +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 Reverted deprecation of media context processor (from r14293) to separate static files and media files a bit more. 2010-11-11 21:44:33 +00:00
internals Added AdminMediaHandler to deprecation docs. 2010-11-11 21:44:05 +00:00
intro Small rewording of tutorial01.txt changes from [14066] 2010-11-08 21:52:32 +00:00
man Fixed #14524, #14582, #14617, #14665 and #14667 -- Tweaked staticfiles app. 2010-11-11 21:43:49 +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 Reverted deprecation of media context processor (from r14293) to separate static files and media files a bit more. 2010-11-11 21:44:33 +00:00
releases Correct a typo in [14541]. 2010-11-12 16:35:40 +00:00
topics Fixed #14669 -- corrected an ungrammatical sentence in the internationalization docs. Thanks to steveire for the report. 2010-11-12 02:48: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
conf.py Disabled unused Sphinx configuration option that triggered a warning. 2010-10-08 15:33:27 +00:00
contents.txt
…
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 #14641 - a handful of grammer/typo fixes. 2010-11-08 20:37:52 +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/