mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 23:44:22 +00:00
Code Issues 24 Releases Wiki Activity
3abcd9d3e2
django/docs
History
Gabriel Hurley 3abcd9d3e2 Fixed #14767 -- Reflowed paragraphs and cleaned up some markup/links in the topics/db/optimizations docs. Thanks to adamv for the report and patch. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14690 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-24 11:52:15 +00:00
..
_ext Reformated some code for readability. 2010-11-20 21:00:41 +00:00
_theme/djangodocs
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 Clarified a comment in the mod_python docs on the status of the handler. Thanks to mattmcc for the report. 2010-11-22 12:29:22 +00:00
internals Fixed #14389, #9666 -- Started the migration path to make the first argument to url and ssi template tags syntactically consistent with other tags. Thanks to Sean Brant for the draft patch. 2010-11-20 06:22:28 +00:00
intro Fixes #6739 -- better development installation docs. Thanks to Adam Vandenberg for inspiration. 2010-11-23 03:54:13 +00:00
man Fixed #14693, #14709 -- Backwards incompatible change to rectify the confusion around the STATICFILES_URL and STATICFILES_ROOT settings. 2010-11-17 15:36:26 +00:00
misc
obsolete
ref Fixes #3529 -- more explicit documentation about Context.update. Thanks for the patch, ggetzie. 2010-11-24 00:36:36 +00:00
releases Clarified the text describing the deprecation status of mod_python. Thanks to mattmcc and Tai Lee for pointing out the ambiguity. 2010-11-22 12:13:18 +00:00
topics Fixed #14767 -- Reflowed paragraphs and cleaned up some markup/links in the topics/db/optimizations docs. Thanks to adamv for the report and patch. 2010-11-24 11:52:15 +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 Added a hidden toctree pointing at the index file in the docs to silence a sphinx warning. 2010-11-17 20:26:20 +00:00
glossary.txt
index.txt Fixed #14641 - a handful of grammer/typo fixes. 2010-11-08 20:37:52 +00:00
Makefile
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/