0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
Ryan Nowakowski f39b8867a1 Unicode method on model should return unicode
The example of a __unicode__ model method should return a unicode value
instead of a string.
2014-06-02 22:49:43 -05:00
..
_ext
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Used link label in models FAQ to ease translation 2014-05-22 09:46:34 +02:00
howto Fixed #22619 -- Corrected description of os.path. 2014-05-12 18:56:34 -04:00
internals Updated some docs for the delayed deprecation of legacy table creation; refs #22340. 2014-05-07 09:04:01 -04:00
intro Reordered tutorial 1 so that the database is configured first. 2014-05-05 13:34:46 -04:00
man Completed long overdue sqlinitialdata deprecation. 2014-05-11 23:15:59 -03:00
misc
ref Unicode method on model should return unicode 2014-06-02 22:49:43 -05:00
releases Fixed #11776 -- Added CSS class for non-field/top of form errors. 2014-06-02 15:22:15 -04:00
topics Fixed #11776 -- Added CSS class for non-field/top of form errors. 2014-06-02 15:22:15 -04:00
conf.py Fixed several typos in Django 2014-05-28 17:39:14 -07:00
contents.txt
glossary.txt
index.txt Added array field support for PostgreSQL. 2014-05-22 09:53:26 +01:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Fixed spelling in docs. 2014-05-27 19:46:48 -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/