django/docs
Bouke Haarsma 7a7c789d5a Fixed #5849 -- Strip whitespace from blocktrans
Add the trimmed option to the blocktrans tag to trim any newlines and
whitespace from its content.

This allows the developer to indent the blocktrans tag without adding
new lines and whitespace to the msgid in the PO file.

Thanks to mpessas for the initial patch and Dmitri Fedortchenko for the
report.
2013-11-08 00:52:17 +02:00
..
_ext Fixed all E226 violations 2013-11-03 10:08:55 -08:00
_theme/djangodocs Fixed #20910 -- Added a "snippet" sphinx directive to allow prefixing a filename. 2013-10-14 13:00:57 -04:00
faq Fixed #8918 -- Made FileField.upload_to optional. 2013-10-11 08:07:25 -04:00
howto Fixed #20962 -- Documented that template tag render() may raise exceptions. 2013-10-14 11:53:15 -04:00
internals Added more items to the release checklist. 2013-11-07 14:45:59 +01:00
intro Fixed indentation of example in tutuorial 2. 2013-10-22 08:10:56 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Fixed #17001 -- Custom querysets for prefetch_related. 2013-11-07 14:49:49 +02:00
releases Fixed #5849 -- Strip whitespace from blocktrans 2013-11-08 00:52:17 +02:00
topics Fixed #5849 -- Strip whitespace from blocktrans 2013-11-08 00:52:17 +02: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
conf.py Fixed all E261 warnings 2013-11-02 18:20:39 -04: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 Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -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 ``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/