django/docs
Claude Paroz b0d8085c67 Added note about including fixtures hashing algorithm
Refs #18157.
2012-06-09 21:14:13 +02:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Removed references to changes made in 1.2. 2012-06-07 15:02:35 +02:00
howto Fixed #18440 -- Pointed out that ReportLab is not thread safe. Thanks, jens@lundstroem.com 2012-06-08 11:46:45 -05:00
internals Added myself to committers 2012-06-08 15:22:58 +03:00
intro Fixed #17933 -- Added a missing label to the docs. 2012-06-07 19:47:32 +02:00
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc Fixed #18033 -- Removed function-based generic views, as per official deprecation timeline. Rest in peace! Thanks Anssi Kääriäinen for the review. 2012-04-25 19:17:47 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Cleaned whitespace errors introduced in previous commit 2012-06-08 23:52:43 +03:00
releases Fixed #17159 -- Validated returned number of next|previous_page_number 2012-06-09 17:55:24 +02:00
topics Added note about including fixtures hashing algorithm 2012-06-09 21:14:13 +02:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
README Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112. 2012-03-03 09:11:54 +00:00
conf.py Fixed #18269 -- Applied unicode_literals for Python 3 compatibility. 2012-06-07 18:08:47 +02:00
contents.txt Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch. 2010-12-27 23:58:16 +00:00
glossary.txt Fixed #18033 -- Removed function-based generic views, as per official deprecation timeline. Rest in peace! Thanks Anssi Kääriäinen for the review. 2012-04-25 19:17:47 +00:00
index.txt Fixed #18436 -- Updated contributing docs for git. 2012-06-07 18:54:43 +02:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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.pocoo.org/