django

mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00

History

Claude Paroz f95baa1d8a Added missing indentation in models topic documentation. git-svn-id: http://code.djangoproject.com/svn/django/trunk@17812 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-03-27 09:07:03 +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	Added Django-Python version matching table in FAQ.	2012-03-16 18:41:31 +00:00
howto	Updated some outdated external URLs in docs.	2012-03-14 07:41:02 +00:00
internals	Fixed #17837 . Improved markdown safety.	2012-03-14 19:06:23 +00:00
intro	Bump the version in a docs example.	2012-03-23 18:05:31 +00:00
man	Fix lintian error in manpages.	2012-03-25 19:04:11 +00:00
misc	Replaced http by https in djangoproject.com links	2012-03-13 17:53:31 +00:00
obsolete
ref	Fixed #17733 -- Discouraged setting TIME_ZONE to None when USE_TZ is True. Thanks berdario for the report.	2012-03-26 14:17:13 +00:00
releases	Fixed #17963 -- Fixed internal links in the 1.4 release notes.	2012-03-23 19:44:52 +00:00
topics	Added missing indentation in models topic documentation.	2012-03-27 09:07:03 +00:00
conf.py	Bump trunk to 1.4.	2012-03-23 16:53:23 +00:00
contents.txt
glossary.txt	Replaced http by https in djangoproject.com links	2012-03-13 17:53:31 +00:00
index.txt	Replaced http by https in djangoproject.com links	2012-03-13 17:53:31 +00:00
make.bat
Makefile
README	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +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/