1
0
mirror of https://github.com/django/django.git synced 2024-11-18 23:44:22 +00:00
django/docs
2011-09-25 05:21:29 +00:00
..
_ext Fixed djangodocs Sphinx extension to work with latest Sphinx 2011-05-15 23:02:36 +00:00
_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 Fixed #16863 -- Corrected ReST markup to avoid errors building docs. 2011-09-16 18:06:42 +00:00
internals Fixed #16907 (again) -- Added deprecation of databrowse to the deprecation docs. 2011-09-22 22:44:00 +00:00
intro Fixed #14675 -- Completed removal of from django.conf.urls.default import * usage. 2011-09-11 22:36:16 +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 Fixed #16927 -- Corrected the {% ifchanged %} template tag's documentation. Thanks to sebastian for the report and patch. 2011-09-25 05:21:29 +00:00
releases Simplified the admin changelist multi-sort interface specifically by removing the popup window, adding explicit tooltip help texts, improving the hover visual states and allowing all operations (i.e. removing a column from sorting and toggling the sorting with and without changing the sorting priority) to be actionable with just one click. Many thanks to Idan Gazit for the feedback and direction. Refs #16212. 2011-09-24 06:17:53 +00:00
topics Fixed #16789 -- Added names to URLs in convenience contrib.auth urls.py. 2011-09-24 19:48:27 +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 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 Converted links to external topics so they use intersphinx extension markup. 2011-09-04 21:17:30 +00:00
index.txt Fixed #16057 -- Extended deployment documentation with instructions for uWSGI. Thanks, jpic and aaugustin. 2011-06-16 16:34:12 +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
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/