django

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

History

Tim Graham ba50d3e05b Fixed #14633 - Organized settings reference docs and added a topical index. Thanks Gabriel Hurley for the original idea and adamv for the draft patch.		2013-01-12 18:44:53 -05:00
..
_ext
_theme/djangodocs	Addeded CSS to bold deprecation notices.	2013-01-09 19:03:34 -05:00
faq	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
howto	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
internals	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
intro	Fixed #19437 - Clarified pip install instructions in contributing tutorial.	2013-01-11 07:01:56 -05:00
man
misc	Removed django.contrib.localflavor.	2012-12-29 21:59:06 +01:00
ref	Fixed #14633 - Organized settings reference docs and added a topical index.	2013-01-12 18:44:53 -05:00
releases	Fixed typo in 1.5 release notes; thanks Jonas Obrist.	2013-01-07 20:16:46 -07:00
topics	Fixed #14633 - Organized settings reference docs and added a topical index.	2013-01-12 18:44:53 -05:00
conf.py	Fixed broken links, round 3. refs #19516	2012-12-26 19:07:22 -05:00
contents.txt	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07:00
glossary.txt
index.txt	Removed django.contrib.localflavor.	2012-12-29 21:59:06 +01:00
make.bat	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
Makefile	Fixed #19516 - Fixed remaining broken links.	2013-01-02 18:32:57 -05:00
README	Fixed #18928 . Tightened language in docs/README.	2012-09-08 11:11:37 +05:30

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.pocoo.org/