1
0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
django/docs
Tim Graham ac4aa8a76c Documented that contrib.sites creates a default site.
Thanks Lorin Hochstein for the patch.
2012-11-17 06:49:28 -05:00
..
_ext
_theme/djangodocs
faq Merge pull request #485 from asparagui/add_period 2012-11-02 16:17:25 -07:00
howto Fixed #19208 -- Docs for mod_wsgi daemon mode 2012-10-29 21:39:12 +01:00
internals Added a note and link to CLA from contributing docs 2012-11-04 12:25:48 -08:00
intro Fixed #19289 - Removed an out of place sentence in tutorial 2. 2012-11-14 05:46:30 -05:00
man
misc Replaced mentions of Subversion by Git in docs 2012-10-14 23:03:01 +02:00
ref Documented that contrib.sites creates a default site. 2012-11-17 06:49:28 -05:00
releases Fixed #18985 -- made DeprecationWarnings loud 2012-11-16 17:07:38 -08:00
topics fixed a broken link in the docs 2012-11-13 14:48:23 -08:00
conf.py Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt
index.txt Fixed #16671 - Added a tutorial on reuseable apps 2012-10-30 18:40:21 -04:00
make.bat Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
Makefile Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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