django

mirror of https://github.com/django/django.git synced 2024-11-30 07:06:18 +01:00

History

Andrew Godwin dbe82e74f2 Add reference documentation for operations and stubs for schemaeditor.		2014-02-12 18:53:35 +00:00
..
_ext	Fixed #21869 -- Fixed docs building with Sphinx 1.2.1.	2014-01-24 08:52:43 -05:00
_theme	Fixed #21190 -- Added a new ePub theme for documentation.	2014-02-10 08:24:40 -05: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 #21674 -- Deprecated the import_by_path() function in favor of import_string().	2014-02-08 11:12:19 -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	Add reference documentation for operations and stubs for schemaeditor.	2014-02-12 18:53:35 +00:00
releases	Fixed #2445 -- Allowed limit_choices_to attribute to be a callable.	2014-02-11 14:05:12 -05:00
topics	Add reference documentation for operations and stubs for schemaeditor.	2014-02-12 18:53:35 +00:00
conf.py	Fixed #21190 -- Added a new ePub theme for documentation.	2014-02-10 08:24:40 -05:00
contents.txt
glossary.txt
index.txt	Add reference documentation for operations and stubs for schemaeditor.	2014-02-12 18:53:35 +00:00
make.bat
Makefile
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/