django

History

Tim Graham bd006e00e4 Merge pull request #737 from hrbonz/docs_CBV_generic_views_typo Fixed typo in docs/topics/class-based-views/generic-display.txt		2013-02-19 13:30:28 -08:00
..
_ext	Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives	2013-02-09 09:16:10 -05:00
_theme/djangodocs	…
faq	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
howto	Fixed #19749 -- Documented ending param to command's self.stdout/err	2013-02-09 10:17:26 +01:00
internals	Fixed #19689 -- Renamed `Model._meta.module_name` to `model_name`.	2013-02-05 04:16:07 -05:00
intro	Updated tutorial 1 to reflect changes in default project template.	2013-02-10 18:07:50 -05:00
man	Revert "Patch by Claude for #16084."	2013-01-25 13:58:37 -03:00
misc	…
ref	Added a new required ALLOWED_HOSTS setting for HTTP host header validation.	2013-02-19 11:23:29 -07:00
releases	Update 1.5 release notes for XML and formset fixes.	2013-02-19 11:23:30 -07:00
topics	Merge pull request #737 from hrbonz/docs_CBV_generic_views_typo	2013-02-19 13:30:28 -08:00
Makefile	…
README	…
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	…
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/