p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
Ramon Moraes 5864e1f8e9 [1.4.x] Updated xhtml2pdf URL in docs. 2016-02-16 07:10:13 -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] Updated xhtml2pdf URL in docs. 2016-02-16 07:10:13 -05:00
internals [1.4.x] Added link to download page to find supported versions. 2015-04-04 08:00:44 -04: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 DoS possiblity in contrib.auth.views.logout() 2015-08-18 08:35:42 -04:00
topics [1.4.x] Fixed DoS possiblity in contrib.auth.views.logout() 2015-08-18 08:35:42 -04: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] Bumped version for 1.4.22 release. 2015-08-18 08:39:59 -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/