django/docs
Adam Johnson c1d652c62f Fixed typo in docs/releases/1.10.6.txt. 2017-03-01 10:11:32 -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 Fixed #27823 -- Updated mod_wsgi example to use WSGIPythonHome. 2017-02-13 19:52:08 -05:00
internals Refs #25187 -- Fixed AuthBackend.authenticate() compatibility for signatures that accept a request kwarg. 2017-02-24 10:15:41 -05:00
intro Used "0" ip shortcut for runserver example. 2017-02-21 19:13:00 -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 #27842 -- Added protocol kwarg to GenericSitemap.__init__(). 2017-02-28 11:48:07 -05:00
releases Fixed typo in docs/releases/1.10.6.txt. 2017-03-01 10:11:32 -05:00
topics Imported django.http classes instead of django.http. 2017-02-27 14:47:11 -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 Removed docs/internals/roles.txt. 2017-02-15 09:31:41 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
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/