django1/docs
Charlie Denton 8b62e5df86 Fixed typo in docs/releases/2.0.txt. 2017-02-06 07:57:11 -05: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 Fixed spelling of "nonexistent". 2017-02-03 08:01:45 -05:00
howto Added missing word in docs/howto/error-reporting.txt. 2017-01-30 15:38:55 -05:00
internals Refs #23919 -- Removed misc Python 2/3 references. 2017-01-25 13:59:25 -05:00
intro Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow. 2017-01-28 11:45:04 -05:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Fixed #27767 -- Added distinct argument to ArrayAgg. 2017-02-04 13:57:39 -05:00
releases Fixed typo in docs/releases/2.0.txt. 2017-02-06 07:57:11 -05:00
topics Refs #23919 -- Replaced kwargs.pop() with keyword-only arguments. 2017-02-01 11:41:56 -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
conf.py Refs #23919 -- Removed Python 2 notes in docs. 2017-01-18 11:51:29 -05: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 Refs #23919 -- Removed Python 2 notes in docs. 2017-01-18 11:51:29 -05:00
make.bat
spelling_wordlist Fixed #15667 -- Added template-based widget rendering. 2016-12-27 17:50:10 -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/