1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2014-12-28 17:02:30 +01:00
..
_ext Fixed #23968 -- Replaced list comprehension with generators and dict comprehension 2014-12-08 07:58:23 -05:00
_theme
faq Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
howto Deprecated ALLOWED_INCLUDE_ROOTS. 2014-12-28 17:02:30 +01:00
internals Deprecated TEMPLATE_STRING_IF_INVALID. 2014-12-28 17:02:30 +01:00
intro Clarified custom header instructions in tutorial 2. 2014-12-26 18:28:47 -05:00
man
misc
ref Deprecated TEMPLATE_STRING_IF_INVALID. 2014-12-28 17:02:30 +01:00
releases Deprecated TEMPLATE_STRING_IF_INVALID. 2014-12-28 17:02:30 +01:00
topics Deprecated TEMPLATE_STRING_IF_INVALID. 2014-12-28 17:02:30 +01:00
conf.py Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
contents.txt
glossary.txt
index.txt Fixed #23753 -- Added a suite of SQL Functions 2014-12-27 15:27:27 +11:00
make.bat
Makefile
README
spelling_wordlist Fixed #23753 -- Added a suite of SQL Functions 2014-12-27 15:27:27 +11: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/