django/docs
Unai Zalakain 3895d8899d Fixed #21213 -- Added docs for Django's mailing lists.
Added docs/internals/mailing-lists.txt documenting the use of django's
mailing lists. All references across docs changed to point to this page.

The referencing makes use of substitution because there's no way to make
a :ref: link in a non-inline fashion in Sphinx. It also makes use of
rst_epilog Sphinx conf for making this substitutions across all the
docs.
2013-10-04 10:00:36 -04:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs Fixed #21702 -- Added different bullet styles for nested lists. 2013-09-23 07:37:09 -04:00
faq Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
howto Fixed #21218 -- Typo on docs/howto/upgrade-version.txt 2013-10-03 20:13:33 -04:00
internals Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
intro Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
ref Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
releases Fixed #19321 -- Allowed redirect middleware HTTP responses to be overridden. 2013-10-04 07:36:39 -04:00
topics Fixed #10913 -- Documented how related_name affects QuerySet filtering 2013-10-02 12:12:53 -04:00
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03:00
conf.py Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -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/