1
0
mirror of https://github.com/django/django.git synced 2024-12-24 18:16:19 +00:00
django/docs
Aymeric Augustin ba7206cd81 Changed get_model to raise an exception on errors.
Returning None on errors required unpythonic error checking and was
inconsistent with get_app_config.

get_model was a private API until the previous commit, but given that it
was certainly used in third party software, the change is explained in
the release notes.

Applied the same change to get_registered_model, which is a new private
API introduced during the recent refactoring.
2013-12-28 20:53:00 +01:00
..
_ext Fixed E127 pep8 warnings. 2013-12-14 11:59:15 -05:00
_theme/djangodocs Fixed #21558 -- Support building CHM files. 2013-12-04 16:46:56 +01:00
faq Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
howto Used app_label instead of appname. 2013-12-28 09:53:02 +01:00
internals Updated the AppCommand API to support apps without a models module. 2013-12-28 09:42:59 +01:00
intro Unified listing of shell commands/code 2013-12-25 15:19:14 -05:00
man Used app_label instead of appname. 2013-12-28 09:53:02 +01:00
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Changed get_model to raise an exception on errors. 2013-12-28 20:53:00 +01:00
releases Changed get_model to raise an exception on errors. 2013-12-28 20:53:00 +01:00
topics Fixed doc indentation in previous commit. 2013-12-28 11:33:24 -05:00
conf.py Fixed all E261 warnings 2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt Documented the Apps and AppConfig APIs. 2013-12-24 17:20:11 +01: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/