django

mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00

History

Nathan Smith 44d40ba521 Fixed minor typos.		2014-01-02 15:14:11 -05: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	Used app_label instead of appname.	2013-12-28 09:53:02 +01:00
internals	Fixed #21701 -- Improved testing doc titles and added testing/tools.txt.	2013-12-31 08:14:09 -05:00
intro	Fixed #21701 -- Improved testing doc titles and added testing/tools.txt.	2013-12-31 08:14:09 -05:00
man	Used app_label instead of appname.	2013-12-28 09:53:02 +01:00
misc	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
ref	Fixed minor typos.	2014-01-02 15:14:11 -05:00
releases	Fix typo in `0ce945a671`.	2014-01-02 09:06:52 +00:00
topics	Fixed typos. Changed grammar.	2014-01-02 14:22:52 -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/