mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 24 Releases Wiki Activity
django/docs
History
Tim Graham 541310023d Forward ported docs of security issues from df81625da6. 2014-05-07 08:21:54 -04:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Improve docs around deconstruction/serialisation (refs #22337) 2014-05-06 23:06:41 -07:00
internals Bump DatabaseCreation deprecation to 2.0 (refs #22340) 2014-05-06 22:14:15 -07:00
intro Reordered tutorial 1 so that the database is configured first. 2014-05-05 13:34:46 -04:00
man Fixed clash caused by the newly introduced -e shorthand for makemessages --exclude. 2014-05-02 23:07:17 +07:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Updated the messages context processor docs 2014-05-06 20:37:52 +02:00
releases Forward ported docs of security issues from df81625da6. 2014-05-07 08:21:54 -04:00
topics Improve docs around deconstruction/serialisation (refs #22337) 2014-05-06 23:06:41 -07:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
conf.py Updated doc links to point to Python 3 documentation 2014-04-26 16:02:53 +02:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03: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/