1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2012-12-09 22:30:01 +01:00
..
_ext
_theme/djangodocs Fixed #19317 - Added an image for warning blocks in the docs 2012-11-22 06:34:15 -05:00
faq Fixed #19315 -- Improved markup in admin FAQ. 2012-11-17 23:25:52 +01:00
howto Fix typo in file storage docs. 2012-11-17 23:25:37 +01:00
internals Fixed #19389 -- Docs on the location of contrib apps tests. 2012-12-08 19:47:53 +01:00
intro Fixed #16779 - Added a contributing tutorial 2012-11-17 14:10:25 -05:00
man
misc
ref Fixed #19444 -- Clarified IGNORABLE_404_URLS documentation 2012-12-07 17:39:36 +01:00
releases Typo in the 1.5 release notes 2012-11-28 14:19:05 +01:00
topics Edited the middleware doc for completeness, clarity, and consistency. 2012-12-09 22:30:01 +01:00
conf.py Fixed two docstring/comment typos. 2012-11-28 20:28:30 -03:00
contents.txt
glossary.txt
index.txt Fixed #16779 - Added a contributing tutorial 2012-11-17 14:10:25 -05:00
make.bat Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
Makefile Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01: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/