0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
2013-10-11 15:34:11 -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
internals Fixed #13252 -- Added ability to serialize with natural primary keys. 2013-10-11 12:52:57 -04:00
intro Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
man
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Fixed #13252 -- Added ability to serialize with natural primary keys. 2013-10-11 12:52:57 -04:00
releases Fixed #13252 -- Added ability to serialize with natural primary keys. 2013-10-11 12:52:57 -04:00
topics Minor edits to docs/topics/db/queries.txt. 2013-10-11 15:34:11 -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
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/