django/docs
Claude Paroz 4b4524291a Converted test management command to argparse
Keeping backwards compatibility with test_runner.option_list is
tricky and would imply transforming an optparse.Option to an
argparse.Action. I choose to introduce a backwards incompatible
change because it only affects testing, not runtime behavior.
2014-06-14 13:43:39 +02:00
..
_ext Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-06 20:31:23 -04:00
_theme Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-06 20:31:23 -04:00
faq Fixed #3711, #6734, #12581 -- Bounded connection.queries. 2014-06-07 14:37:43 +02:00
howto Documented optparse to argparse changes for management commands 2014-06-14 13:42:43 +02:00
internals Documented optparse to argparse changes for management commands 2014-06-14 13:42:43 +02:00
intro Fixed #22801 -- Added 'www.' to diveintopython.net links 2014-06-10 15:38:25 -04:00
man Completed long overdue sqlinitialdata deprecation. 2014-05-11 23:15:59 -03:00
misc
ref Fixed #22477 -- Removed contrib middleware from the global settings defaults. 2014-06-13 12:45:56 -04:00
releases Converted test management command to argparse 2014-06-14 13:43:39 +02:00
topics Converted test management command to argparse 2014-06-14 13:43:39 +02:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
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
spelling_wordlist Doc edits for refs #22487. 2014-06-09 12:09:16 -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/