1
0
mirror of https://github.com/django/django.git synced 2024-11-19 07:54:07 +00:00
django/docs
Jon Dufresne 1845bc1d10 Refs #26315 -- Cleaned up argparse options in commands.
* Removed type coercion. Options created by argparse are already coerced
  to the correct type.
* Removed fallback default values. Options created by argparse already
  have a default value.
* Used direct indexing. Options created by argparse are always set. This
  eliminates the need to use dict.get().
2016-03-05 13:19:29 -05:00
..
_ext Fixed #23868 -- Added support for non-unique django-admin-options in docs. 2016-01-14 18:21:33 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -05:00
howto Fixed #26303 -- Updated links to mod_wsgi docs. 2016-03-01 19:22:32 -05:00
internals Removed claim that you can use different database backends for Django's tests. 2016-03-05 08:42:18 -05:00
intro Refs #26312 -- Reworded tutorial 2 to avoid spelling "error". 2016-03-05 10:58:45 -05:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Fixed #26315 -- Allowed call_command() to accept a Command object as the first argument. 2016-03-05 13:05:10 -05:00
releases Refs #26315 -- Cleaned up argparse options in commands. 2016-03-05 13:19:29 -05:00
topics Fixed #26295 -- Allowed using i18n_patterns() in any root URLconf. 2016-03-03 12:08:49 -05:00
conf.py Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:30:32 -05:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
make.bat
Makefile
README
spelling_wordlist Added 'prefetches to docs/spelling_wordlist. 2016-02-26 16:06:34 -05: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 ``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/