django/docs
Mariusz Felisiak 538bf43458 Fixed #27859 -- Ignored db_index for TextField/BinaryField on Oracle and MySQL.
Thanks Zubair Alam for the initial patch and Tim Graham for the review.
2017-05-23 17:02:40 +02:00
..
_ext Refs #23919 -- Replaced super(ClassName, self) with super() in docs. 2017-01-25 11:53:05 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
howto Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
internals Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
intro Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Fixed #27859 -- Ignored db_index for TextField/BinaryField on Oracle and MySQL. 2017-05-23 17:02:40 +02:00
releases Refs #27859 -- Added DatabaseWrapper.display_name. 2017-05-23 09:09:35 -04:00
topics Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02: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
conf.py Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:36:44 -04:00
make.bat
spelling_wordlist Fixed #28062 -- Added a setting to disable server-side cursors on PostgreSQL. 2017-05-06 06:59:04 -04: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/