mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
Code Issues 25 Releases Wiki Activity
e5941ba5f3
django/docs
History
Tim Graham 3cd1db9121 [1.7.x] Fixed #22547 -- Added some links to tutorial 2. 
Thanks bjb at sourcer.ca for the suggestion.

Backport of b0d032f9fc from master
2014-04-30 18:25:32 -04:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq [1.7.x] Added Python 3.4 support notes. 2014-03-27 08:12:58 -04:00
howto [1.7.x] Fixed #22497 -- Highlighted difference between field and class deconstruction. 2014-04-28 08:20:26 -04:00
internals [1.7.x] Fixed #3214 -- Stopped parsing SQL with regex. 2014-04-26 17:46:57 +02:00
intro [1.7.x] Fixed #22547 -- Added some links to tutorial 2. 2014-04-30 18:25:32 -04:00
man Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.7.x] Fixed #19195 -- Allow explicit ordering by a relation _id field. 2014-04-30 14:26:39 -04:00
releases [1.7.x] Fixed #19195 -- Allow explicit ordering by a relation _id field. 2014-04-30 14:26:39 -04:00
topics [1.7.x] Fixed #22442 -- Provided additional documentation regarding id fields clashing. 2014-04-30 07:38:31 -04:00
conf.py [1.7.x] Updated doc links to point to Python 3 documentation 2014-04-26 16:03:40 +02:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist [1.7.x] Various documentation typo/spelling fixes 2014-04-22 20:10:58 -04:00

README 

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