innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity
django1/docs
History
Claude Paroz 27322df995 Fixed #17999 -- Restored the links to examples from models documentation. Refs #17605. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17832 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 		2012-03-30 17:59:12 +00:00
..
_ext Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed 2012-01-11 10:19:05 +00:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Added Django-Python version matching table in FAQ. 2012-03-16 18:41:31 +00:00
howto Fixed 17993 -- Removed quotes around module parameter for wider compatibility. Thanks roberto@unbit.it for the report. 2012-03-28 20:28:13 +00:00
internals Fixed #17837. Improved markdown safety. 2012-03-14 19:06:23 +00:00
intro Bump the version in a docs example. 2012-03-23 18:05:31 +00:00
man Fix lintian error in manpages. 2012-03-25 19:04:11 +00:00
misc Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #17870 -- Documented that EmailField default max_length of 75 does not comply with RFCs 3696/5321. Thanks Rotund for the report and the patch and Russell Keith-Magee for the review. 2012-03-29 18:39:21 +00:00
releases Added stub release notes for 1.5 2012-03-30 09:33:51 +00:00
topics Fixed #17999 -- Restored the links to examples from models documentation. Refs #17605. 2012-03-30 17:59:12 +00: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 Bump trunk to 1.4. 2012-03-23 16:53:23 +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 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/