mirror of
https://github.com/django/django.git
synced 2025-02-15 11:58:44 +00:00
77189afb7f
Part 2 of the model instance documentation changes. Slightly tidied up get_absolute_url() and @permalink documentation to collapse some of the earlier versions into a preferred learning order. I'm still not amazingly happy with this, but larger rewrites are needed to the URLconf stuff across a few files before I can get it into the most natural order, I suspect. That's a slightly longer-term project. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16702 bcc190cf-cafb-0310-a4f2-bffc1f526a37
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`` (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.pocoo.org/