django

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

History

Carl Meyer 966b186981 Fixed #17304 -- Allow single-path and configured-path namespace packages as apps. Also document the conditions under which a namespace package may or may not be a Django app, and raise a clearer error message in those cases where it may not be. Thanks Aymeric for review and consultation.		2014-01-25 19:37:05 -07:00
..
_ext	Fixed #21869 -- Fixed docs building with Sphinx 1.2.1.	2014-01-24 08:52:43 -05:00
_theme/djangodocs	Fixed #21558 -- Support building CHM files.	2013-12-04 16:46:56 +01:00
faq	Django sees more than 1mm hits per hour	2013-12-31 16:23:20 -08:00
howto	Always use parentheses when documenting a method with no arguments.	2014-01-22 22:26:10 +01:00
internals	Fixed #21824 -- Added reference to LTS in docs/internals/security.txt	2014-01-24 08:13:17 -05:00
intro	Fixed #21829 -- Added default AppConfigs.	2014-01-25 10:41:56 +01:00
man	Removed a man page for a command that was removed	2014-01-10 15:23:06 -08:00
misc	Fixed #16785 -- Documented some of the design decisions of the cache framework.	2014-01-16 21:13:08 -05:00
ref	Fixed #17304 -- Allow single-path and configured-path namespace packages as apps.	2014-01-25 19:37:05 -07:00
releases	Fixed #21829 -- Added default AppConfigs.	2014-01-25 10:41:56 +01:00
topics	Fixed #21836 -- Improved transaction docs about autocommit mode	2014-01-25 21:20:17 +01:00
conf.py	Pointed intersphinx links to Python's default version.	2013-12-30 19:09:45 +01:00
contents.txt
glossary.txt
index.txt	Fixed #16905 -- Added extensible checks (nee validation) framework	2014-01-20 10:45:21 +08: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

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/