django/docs
Tim Graham afa3e16334 Fixed #19743 - Documented some limitations of contrib.auth.
Thanks Aymeric for the suggestion.
2013-02-06 08:24:38 -05:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Addeded CSS to bold deprecation notices. 2013-01-09 19:03:34 -05:00
faq Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
howto Simplified default project template. 2013-02-04 13:21:36 +01:00
internals Fixed #19689 -- Renamed `Model._meta.module_name` to `model_name`. 2013-02-05 04:16:07 -05:00
intro Simplified default project template. 2013-02-04 13:21:36 +01:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc Fixed typos in docs and comments 2013-01-29 10:55:55 -07:00
ref Fixed #9800 -- Allow "isPermaLink" attribute in <guid> element of an RSS item. 2013-02-06 05:28:05 -05:00
releases Fixed #19689 -- Renamed `Model._meta.module_name` to `model_name`. 2013-02-05 04:16:07 -05:00
topics Fixed #19743 - Documented some limitations of contrib.auth. 2013-02-06 08:24:38 -05:00
Makefile Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Added more shortcuts to i18n docs in index page. 2013-01-25 13:50:37 -03:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00

README

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.pocoo.org/