1
0
mirror of https://github.com/django/django.git synced 2025-01-12 03:15:47 +00:00
django/docs
2013-07-13 23:08:48 +02:00
..
_ext
_theme/djangodocs
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Fixed #20493 -- Added a warning that objects may not be picklable across Django versions 2013-07-08 09:57:50 -04:00
internals Added some missing test requirements in the docs; refs #19196 2013-07-10 12:01:17 -04:00
intro Fixed #18261 -- Clarified 'project root directory' 2013-07-09 07:11:41 -04:00
man
misc
ref Removed Python 2.6 references in GIS docs 2013-07-13 23:08:48 +02:00
releases Fixed #20653 -- Renamed checksetup -> check missed in [03465639] 2013-07-12 12:48:49 -04:00
topics Removed obsolete sentence in queries docs 2013-07-13 21:08:44 +02:00
conf.py Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile Allow build of translated documentation 2013-06-08 16:13:51 +02: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/