django/docs
Simon Charette 729e0b086d Fixed #24109 -- Allowed RunSQL and RunPython operations to be elided.
Thanks to Markus Holtermann and Tim Graham for their review.
2016-01-23 14:19:03 -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 Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
howto Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
internals After almost a year I am finally adding myself :)! 2016-01-23 11:43:39 +00:00
intro Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -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 #24109 -- Allowed RunSQL and RunPython operations to be elided. 2016-01-23 14:19:03 -05:00
releases Fixed #24109 -- Allowed RunSQL and RunPython operations to be elided. 2016-01-23 14:19:03 -05:00
topics Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Fixed #23868 -- Added support for non-unique django-admin-options in docs. 2016-01-14 18:21:33 -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
spelling_wordlist Fixed #24109 -- Allowed RunSQL and RunPython operations to be elided. 2016-01-23 14:19:03 -05: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 ``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/