1
0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
django/docs
Tim Graham 821fc925f0 Fixed #22093 -- Made Form.Meta.fields examples consistent.
Thanks david-schultz at gmx.net for the suggestion.
2014-02-19 12:29:47 -05: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 Fixed #22062 -- Corrected static files config for Apache >= 2.4 2014-02-18 09:29:22 -05:00
internals Fixed #21939 -- Deprecated loading ssi/url tags from future. 2014-02-16 13:25:21 +01:00
intro Fixed #21939 -- Deprecated loading ssi/url tags from future. 2014-02-16 13:25:21 +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 #22023 -- Raised an error for values() followed by defer() or only(). 2014-02-17 14:46:13 -05:00
releases Added an example to the release notes for custom reverse managers. 2014-02-19 07:45:24 -05:00
topics Fixed #22093 -- Made Form.Meta.fields examples consistent. 2014-02-19 12:29:47 -05:00
conf.py Fixed #21190 -- Added a new ePub theme for documentation. 2014-02-10 08:24:40 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Add reference documentation for operations and stubs for schemaeditor. 2014-02-12 18:53:35 +00:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
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

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/