0
0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
django/docs
Bouke Haarsma 9b7d38ed5a Fixed #21210 -- Documented when runserver doesn't auto-restart.
Thanks gergely at polonkai.eu for the suggestion.
2013-10-14 10:36:18 -04:00
..
_ext Whitespace cleanup. 2013-10-10 16:49:20 -04:00
_theme/djangodocs Whitespace cleanup. 2013-10-10 16:49:20 -04:00
faq Fixed #8918 -- Made FileField.upload_to optional. 2013-10-11 08:07:25 -04:00
howto Fixed #21218 -- Typo on docs/howto/upgrade-version.txt 2013-10-03 20:13:33 -04:00
internals Amend my description in committers.txt. 2013-10-14 11:54:37 +01:00
intro Fixed #21210 -- Documented when runserver doesn't auto-restart. 2013-10-14 10:36:18 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Fixed #21210 -- Documented when runserver doesn't auto-restart. 2013-10-14 10:36:18 -04:00
releases Fixed #15888 -- Made tablename argument of createcachetable optional 2013-10-14 13:24:40 +02:00
topics Fixed #21264 -- Incorrect RST usage in docs 2013-10-14 08:14:27 -04:00
conf.py Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
contents.txt
glossary.txt
index.txt Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
make.bat
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00

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 ``sudo 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/