django/docs
Vaclav Ehrlich 369fa471f4 Fixed #26201 -- Documented the consequences of rotating the CSRF token on login. 2016-04-05 11:02:38 -04:00
..
_ext
_theme
faq
howto Fixed #24016 -- Added documentation about third-party app data migrations 2016-04-03 17:20:35 +02:00
internals Fixed a broken link in docs/internals/contributing/writing-documentation.txt. 2016-03-19 16:19:01 -04:00
intro Fixed #26416 -- Fixed references to previous tutorial numbers in docs/intro/reusable-apps.txt. 2016-03-28 18:30:30 -04:00
man
misc
ref Fixed #26201 -- Documented the consequences of rotating the CSRF token on login. 2016-04-05 11:02:38 -04:00
releases Fixed #25850 -- Made migrate/makemigrations error on inconsistent history. 2016-04-05 08:52:08 -04:00
topics Removed a reference to Django 1.3.1 in docs. 2016-04-04 11:55:34 -04: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 possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:30:32 -05:00
contents.txt
glossary.txt
index.txt
make.bat
spelling_wordlist Added 'prefetches to docs/spelling_wordlist. 2016-02-26 16:06:34 -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/