django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Kevin Wood 82f466b571 Fix typo in storage docs		2014-01-15 13:17:08 -08:00
..
_ext	Fixed E127 pep8 warnings.	2013-12-14 11:59:15 -05:00
_theme/djangodocs	Fixed #21558 -- Support building CHM files.	2013-12-04 16:46:56 +01:00
faq	Django sees more than 1mm hits per hour	2013-12-31 16:23:20 -08:00
howto	Merge pull request #2094 from coder9042/ticket_21478	2014-01-03 01:30:52 -08:00
internals	Removed BDFL stuff from docs/internals/contributing/bugs-and-features.txt	2014-01-13 10:32:09 -06:00
intro	Fixed #21728 -- Corrected an inadvertent path change in docs/intro/contributing.txt.	2014-01-03 11:59:15 -05:00
man	Removed a man page for a command that was removed	2014-01-10 15:23:06 -08:00
misc	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
ref	Fix typo in storage docs	2014-01-15 13:17:08 -08:00
releases	Fixed #21453 -- Enabled autocommit before calling init_connection_state.	2014-01-12 20:31:07 +01:00
topics	Fixed #12571 -- Attached originating WSGIRequest to test client responses.	2014-01-09 18:50:03 -05:00
conf.py	Pointed intersphinx links to Python's default version.	2013-12-30 19:09:45 +01:00
contents.txt
glossary.txt
index.txt	Documented the Apps and AppConfig APIs.	2013-12-24 17:20:11 +01:00
make.bat
Makefile	Allowed overriding variables in docs/Makefile.	2013-07-29 06:51:54 -04:00
README	Whitespace cleanup.	2013-10-10 16:49:20 -04: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-doc.org/