django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Tim Graham bbf0a9545b Fixed #22482 -- Recommended using data migrations in contrib.sites docs. Thanks scibi for the report.		2014-06-30 18:48:49 -04:00
..
_ext	Removed duplicate "Deprecated in Django A.B" text in docs.	2014-06-06 20:31:23 -04:00
_theme	Made docs CSS for versionchanged/added more similar to docs.djangoproject.com.	2014-06-30 18:38:30 -04:00
faq	Fixed #22880 -- Added FAQ entry about UnicodeDecodeError	2014-06-24 09:02:28 +02:00
howto	Fixed typo in parameter name doc for BaseCommand.check().	2014-06-26 07:23:32 -04:00
internals	Fixed typo: MultipleModelChoiceField -> ModelMultipleChoiceField.	2014-06-23 18:50:51 -04:00
intro	Fixed #22912 -- Warned about a common mistake in tutorial 5.	2014-06-27 09:51:21 -04:00
man	Completed long overdue sqlinitialdata deprecation.	2014-05-11 23:15:59 -03:00
misc	Fixed #16785 -- Documented some of the design decisions of the cache framework.	2014-01-16 21:13:08 -05:00
ref	Fixed #22482 -- Recommended using data migrations in contrib.sites docs.	2014-06-30 18:48:49 -04:00
releases	Fixed #8162 -- Increased Permission.name max_length to 255 characters.	2014-06-30 14:20:51 -04:00
topics	Fixed #19489 -- Documented host parameter of assertRedirects().	2014-06-30 17:52:04 -04:00
conf.py	Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode.	2014-06-07 08:54:54 -04:00
contents.txt
glossary.txt	Fixed some typos in the documentation.	2014-03-02 17:05:57 +01:00
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 #22796 -- Added a more basic explanations of forms.	2014-06-24 14:55:22 -04:00

README

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/