1
0
mirror of https://github.com/django/django.git synced 2025-02-20 14:24:27 +00:00
Tim Graham 4e4c10bc61 Removed docs for @permalink decorator.
It's been marked as "not recommended" since 1.6. Anyone still using it
may refer to older versions of the docs.
2014-07-10 17:30:39 -04:00
..
2014-07-02 23:33:03 -05:00
2013-10-10 16:49:20 -04:00

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

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:

* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) 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-doc.org/