django/docs
kakulukia 992f143bad [1.11.x] Fixed #28278 -- Fixed invalid HTML for a required AdminFileWidget.
Backport of 525dc283a6 from master
2017-06-06 15:57:08 -04:00
..
_ext [1.11.x] Removed usage of deprecated sphinx.util.compat.Directive. 2017-05-24 10:45:12 -04:00
_theme [1.11.x] Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:56 -04:00
faq [1.11.x] Updated various links in docs to avoid redirects 2017-05-22 19:32:02 +02:00
howto [1.11.x] Fixed #26028 -- Added overriding templates howto. 2017-06-02 18:21:35 -04:00
internals [1.11.x] Updated various links in docs to avoid redirects 2017-05-22 19:32:02 +02:00
intro [1.11.x] Updated was_published_recently() tutorial test to check boundary condition. 2017-06-06 12:17:16 -04:00
man [1.11.x] Updated man page for Django 1.11. 2017-04-04 11:53:56 -04:00
misc [1.11.x] Updated various links in docs to avoid redirects 2017-05-22 19:32:02 +02:00
ref [1.11.x] Fixed typo in docs/ref/class-based-views/mixins-single-object.txt. 2017-06-06 11:27:18 -04:00
releases [1.11.x] Fixed #28278 -- Fixed invalid HTML for a required AdminFileWidget. 2017-06-06 15:57:08 -04:00
topics [1.11.x] Fixed typo in docs/topics/testing/advanced.txt. 2017-05-25 05:45:15 -04:00
Makefile [1.11.x] Fixed docs build with Sphinx 1.6. 2017-05-24 09:47:24 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [1.11.x] Fixed docs build with Sphinx 1.6. 2017-05-24 09:47:24 -04: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 [1.11.x] Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:37:04 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.11.x] Fixed #28212 -- Allowed customizing the port that LiveServerTestCase uses. 2017-05-30 18:06:58 -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/