mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 18:16:19 +00:00
Code Issues 25 Releases Wiki Activity
a5cc99de24
django/docs
History
Aymeric Augustin a5cc99de24 [1.7.x] Documented django.setup(). 
Thanks Eric Holscher and Tim Graham for the review.

Backport of 58ed387 from master
2014-04-26 22:11:04 +02:00
..
_ext
_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] Specified 'csv and unicode' note as Python 2 only 2014-04-26 16:10:00 +02:00
internals [1.7.x] Fixed #3214 -- Stopped parsing SQL with regex. 2014-04-26 17:46:57 +02:00
intro [1.7.x] Updated doc links to point to Python 3 documentation 2014-04-26 16:03:40 +02:00
man
misc
ref [1.7.x] Documented django.setup(). 2014-04-26 22:11:04 +02:00
releases [1.7.x] Fixed #3214 -- Stopped parsing SQL with regex. 2014-04-26 17:46:57 +02:00
topics [1.7.x] Updated doc links to point to Python 3 documentation 2014-04-26 16:03:40 +02: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/