django/docs
Ramiro Morales 8b366a50f4 Fixed a couple of typos in GeoDjango docs. 2013-09-12 19:36:45 -03:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Fix broken sphinx reference to staticfiles. 2013-09-10 22:10:00 +02:00
internals Fixed #17262 -- Refactored tzinfo implementations. 2013-09-09 22:32:51 +02:00
intro Fixed #21083 - Fixed spelling in tutorial. 2013-09-10 09:54:26 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Fixed a couple of typos in GeoDjango docs. 2013-09-12 19:36:45 -03:00
releases Added 1.4.7/1.5.3 release notes 2013-09-10 21:07:22 -04:00
topics Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH. 2013-09-11 08:17:15 -04:00
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README
conf.py
contents.txt
glossary.txt
index.txt Consolidated documentation for F() and Q() 2013-09-06 12:57:25 -05:00
make.bat

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/