mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 03:25:58 +00:00
Code Issues 30 Releases Wiki Activity
6b8c8d7e18
django/docs
History
Thomas Güttler 6b8c8d7e18 [1.8.x] Clarified timeout=0 in cache docs. 
Backport of e519ee1d35 from master
2015-02-12 10:32:56 -05:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
howto [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -05:00
internals [1.8.x] Updated docs and runtests.py for removal of tests from contrib. 2015-02-11 12:05:55 -05:00
intro [1.8.x] Updated tutorial 1 with actual migrate output. 2015-01-17 10:46:27 -05:00
man [1.8.x] Removed gather_profile_stats.py 2015-02-06 08:55:02 -05:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.8.x] Refs #14030 -- Improved expression support for python values 2015-02-12 08:53:03 +11:00
releases [1.8.x] Fixed #24200 -- Made introspection bypass statement cache 2015-02-10 23:42:16 +02:00
topics [1.8.x] Clarified timeout=0 in cache docs. 2015-02-12 10:32:56 -05:00
conf.py [1.8.x] Fixed E265 comment style 2015-02-06 09:35:08 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Fixed DoS possibility in ModelMultipleChoiceField. 2015-01-13 13:03:06 -05: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/