django/docs
Luke Plant e364f9ca7a Fixed typo in docs.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14651 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-20 20:40:16 +00:00
..
_ext Fixed hyperlinking of template tags for Sphinx >= 1.0 2010-11-20 01:37:54 +00:00
_theme/djangodocs
faq
howto 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
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
man
misc
obsolete
ref Fixed typo in docs. 2010-11-20 20:40:16 +00:00
releases 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
topics Documented migration path for change object_list -> ListView regarding different context variables 2010-11-20 20:38:52 +00:00
Makefile
README
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

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/