django/docs
bmsleight 8715205c5c Fixed a typo in a modelforms docs example. 2016-01-09 13:00:59 -05:00
..
_ext Removed a docs workaround for an old Sphinx version. 2015-11-16 18:49:32 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Fixed #25881 -- Marked Python 3.2 in Django 1.8 as unsupported at the end of 2016. 2015-12-08 10:55:49 -05:00
howto Fixed #26055 -- Removed an orphaned phrase in docs/howto/deployment/wsgi/modwsgi.txt. 2016-01-08 09:36:58 -05:00
internals Refs #25746 -- Added a test utility to isolate inlined model registration. 2016-01-06 20:00:07 -05:00
intro Added a missing import in tutorial 3. 2016-01-02 09:39:25 -05:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
ref Refs #25995 -- Documented that JSONField doesn't handle sophisticated serialization. 2016-01-08 19:00:56 -05:00
releases Fixed #20846 -- Decreased User.username max_length to 150 characters. 2016-01-08 18:06:44 -05:00
topics Fixed a typo in a modelforms docs example. 2016-01-09 13:00:59 -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 Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Fixed #26003 -- Added "how the documentation is organized" sections. 2015-12-31 11:35:00 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -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/