django/docs
Claude Paroz f5afa22abd Add myself to committers
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17701 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-03-13 17:35:00 +00:00
..
_ext Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed 2012-01-11 10:19:05 +00:00
_theme/djangodocs
faq
howto Fixed #17842 - Typo in uWsgi docs; thanks mitnk. 2012-03-10 10:03:33 +00:00
internals Add myself to committers 2012-03-13 17:35:00 +00:00
intro Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112. 2012-03-03 09:11:54 +00:00
man Fixed a couple of minor errors in the django-admin(1) Unix man page. 2012-02-06 02:00:19 +00:00
misc
obsolete
ref Fixed #17857 -- Stopped CachedStaticFilesStorage from creating absolute URLs unnecessarily. Thanks, tgecho. 2012-03-13 03:48:11 +00:00
releases Add a note to the backwards-incompatible changes section of 1.4 release notes about the change related to loading fixtures with incomplete data for auto_now and auto_now_add fields. Refs #12753. Thanks ptone. 2012-03-13 00:15:43 +00:00
topics Edited some docs and docstrings until [17685] 2012-03-12 20:05:48 +00:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
README Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112. 2012-03-03 09:11:54 +00:00
conf.py Bump for 1.4 RC 1. 2012-03-05 17:22:23 +00:00
contents.txt
glossary.txt Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
index.txt
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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/