django

mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00

History

Tim Graham 4bf86d25e5 Added stub release notes for 1.7.2.		2014-10-22 13:38:57 -04:00
..
_ext	Added sphinx extension to ease generation of ticket links.	2014-08-19 17:40:50 -04:00
_theme	Added newlines to the ends of CSS, HTML, and JavaScript files missing them.	2014-08-12 19:22:09 -04:00
faq	Fixed #23527 -- Removed Cheetah references in docs	2014-09-21 18:03:31 +02:00
howto	Fixed #23637 -- Removed TUX, lighttpd, and Cherokee as common.	2014-10-15 08:28:27 -04:00
internals	Fixed IRC channel name in submitting-patches.txt.	2014-10-16 16:56:37 +03:00
intro	Fixed #23587 -- Clarified admin template overriding in tutorial 2.	2014-10-08 08:19:11 -04:00
man	Replaced django-admin.py with django-admin in the man page.	2014-07-31 23:46:49 +02:00
misc
ref	Fixed firstof docs error introduced in 1ea44a; refs #17906 .	2014-10-21 09:08:27 -04:00
releases	Added stub release notes for 1.7.2.	2014-10-22 13:38:57 -04:00
topics	Removed unused import from the JSON serialization example.	2014-10-21 23:49:40 -04:00
conf.py	Added sphinx extension to ease generation of ticket links.	2014-08-19 17:40:50 -04:00
contents.txt
glossary.txt	Fixed some intersphinx references.	2014-10-16 20:00:17 -04:00
index.txt	Fixed #17101 -- Integrated django-secure and added check --deploy option	2014-09-12 15:05:23 -04:00
make.bat
Makefile
README	Removed sudo from pip commands in docs.	2014-09-22 15:49:48 -04:00
spelling_wordlist	Updated docs/spelling_wordlist	2014-10-02 11:52:05 +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 ``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/