0
0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
django/docs
Dražen Lučanin b5eef8535a Recommended setuptools in the reuseable app tutorial.
setuptools has merged with distribute.
2013-11-19 13:57:17 -05:00
..
_ext Fixed all E226 violations 2013-11-03 10:08:55 -08:00
_theme/djangodocs Fixed #20910 -- Added a "snippet" sphinx directive to allow prefixing a filename. 2013-10-14 13:00:57 -04:00
faq Fixed #8918 -- Made FileField.upload_to optional. 2013-10-11 08:07:25 -04:00
howto Fixed #20962 -- Documented that template tag render() may raise exceptions. 2013-10-14 11:53:15 -04:00
internals Fixed #21351 -- Replaced memoize with Python's lru_cache. 2013-11-11 08:53:09 +01:00
intro Recommended setuptools in the reuseable app tutorial. 2013-11-19 13:57:17 -05:00
man
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref fixed typo in builtins.txt 2013-11-19 12:53:28 -05:00
releases Fixed #15179 -- middlewares not applied for test client login() 2013-11-19 09:04:20 +02:00
topics Added more examples to the get_object_or_404 documentation. 2013-11-19 19:23:44 +01:00
conf.py Fixed all E261 warnings 2013-11-02 18:20:39 -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/