1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
Tim Graham 9d4baf80c6 Merge pull request #549 from WoLpH/master
Changed an if statement in the docs to a slightly cleaner variant.
2012-11-23 04:12:54 -08: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 #19291 -- Completed deprecation of ADMIN_MEDIA_PREFIX. 2012-11-17 22:38:19 +01:00
intro Fixed #16779 - Added a contributing tutorial 2012-11-17 14:10:25 -05:00
man
misc Replaced mentions of Subversion by Git in docs 2012-10-14 23:03:01 +02:00
ref Fixed #19348 - Clarified the units of filesizeformat. 2012-11-23 07:00:08 -05:00
releases Spell checked 1.5 alpha release notes 2012-11-22 17:16:04 -05:00
topics changed if statement to a slightly cleaner/less confusing variant 2012-11-22 22:29:39 +01:00
conf.py Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01: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/