0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
2011-09-10 01:53:56 +00:00
..
_ext
_theme/djangodocs
faq Fixed typo in PEP number introduced in last commit. Thanks Jannis for the eagle eyes. 2011-09-04 22:42:11 +00:00
howto Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
internals Altered the behavior of URLField to avoid a potential DOS vector, and to avoid potential leakage of local filesystem data. A security announcement will be made shortly. 2011-09-10 00:47:00 +00:00
intro Fixed #16782 -- Corrected a broken cross-reference to the database engine setting in the tutorial. Thanks to mjumbewu for the report and patch. 2011-09-09 23:25:48 +00:00
man Fixed #16099 -- Enabled threading for the runserver management command and added a --nothreading option to disable it if needed. This should help Google Chrome users because it opens more than one connection speculatively. 2011-06-17 13:08:36 +00:00
misc Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
obsolete
ref Altered the behavior of URLField to avoid a potential DOS vector, and to avoid potential leakage of local filesystem data. A security announcement will be made shortly. 2011-09-10 00:47:00 +00:00
releases Altered the behavior of URLField to avoid a potential DOS vector, and to avoid potential leakage of local filesystem data. A security announcement will be made shortly. 2011-09-10 00:47:00 +00:00
topics Make `Formset.__getitem__ O(1), rather than O(n). If you override __iter__ you now need to also override __getitem__` for consistant behavior. Thanks to Carl and Russ for the review. 2011-09-10 01:53:56 +00:00
conf.py Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
contents.txt
glossary.txt Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
index.txt
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
Makefile
README Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00

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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_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/