0
0
mirror of https://github.com/django/django.git synced 2024-11-28 10:48:32 +01:00
django/docs
2014-11-16 21:41:42 +01:00
..
_ext
_theme
faq
howto Renamed qn to compiler 2014-11-16 13:19:34 +01:00
internals Deprecated function-based loaders. 2014-11-16 21:41:42 +01:00
intro Fixed #23588 -- Added a link in tutorial for list_display options. 2014-11-13 20:15:45 +01:00
man
misc
ref Moved all template loaders under django.template.loaders. 2014-11-16 21:28:26 +01:00
releases Deprecated function-based loaders. 2014-11-16 21:41:42 +01:00
topics Merge pull request #3524 from nmundar/ticket_23690 2014-11-16 09:21:12 +00:00
conf.py Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03:00
contents.txt
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
Makefile
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/