django/docs
Simon Charette 5940da16af [1.4.x] Fixed #23754 -- Always allowed reference to the primary key in the admin
This change allows dynamically created inlines "Add related" button to work
correcly as long as their associated foreign key is pointing to the primary
key of the related model.

Thanks to amorce for the report, Julien Phalip for the initial patch,
and Collin Anderson for the review.

Backport of f9c4e14aec from master
2014-11-25 14:04:56 -05:00
..
_ext [1.4.x] Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 09:05:59 -05:00
_theme/djangodocs [1.4.x] Fixed #21558 -- Support building CHM files. 2013-12-04 16:52:30 +01:00
faq [1.4.X] Fixed #17511 - Removed reference to deprecated "reset" management command in FAQ; thanks voxpuibr@ for the report. 2012-06-27 18:56:04 -04:00
howto [1.4.x] Fixed spelling mistake in file docs. 2014-08-26 09:45:06 -04:00
internals [1.4.x] Added a note about LTS releases. 2014-01-19 18:46:57 +01:00
intro [1.4.x] Fixed #21195 -- Clarifed usage of template_name in tutorial part 4. 2014-03-05 22:35:37 +01:00
man [1.4.X] Fix lintian error in manpages. 2012-03-29 15:08:38 +00:00
misc [1.4.x] Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-25 12:55:12 -05:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref [1.4.x] Fixed #23631 -- Removed outdated note on MySQL timezone support. 2014-10-10 15:22:46 -04:00
releases [1.4.x] Fixed #23754 -- Always allowed reference to the primary key in the admin 2014-11-25 14:04:56 -05:00
topics [1.4.x] Fixed #23149 -- Clarified note on HTTPOnly in cookie-based session docs 2014-08-02 19:01:23 +02:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +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 [1.4.x] Bump version numbers for bugfix release. 2014-10-22 12:36:19 -04: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 Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
index.txt Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +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/