0
0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
django/docs
Kevin Ndung'u 0d74209ef6 Fixed #23900 -- Added missing imports in code example.
The Preventing header injection example included
classes that are not imported.

Thanks to Collin Anderson and Berker Peksağ for the
reviews.
2014-11-23 23:03:58 +01: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 #20435 -- Reordered the custom template tags docs. 2014-11-17 17:38:04 +01:00
internals Fixed typo in docs/internals/release-process.txt. 2014-11-21 11:47:31 -05:00
intro Fixed #23855 -- Removed unnecessary all() in tutorial 3. 2014-11-17 18:10:50 +01:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Deprecated dirs argument to override TEMPLATE_DIRS. 2014-11-23 09:29:33 +01:00
releases Move compile_string into the Engine class. 2014-11-23 11:52:25 +01:00
topics Fixed #23900 -- Added missing imports in code example. 2014-11-23 23:03:58 +01:00
conf.py Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03: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 Fixed #14030 -- Allowed annotations to accept all expressions 2014-11-15 14:00:43 +00:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Fixed spelling errors in docs. 2014-11-11 16:41:09 +01:00

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/