mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-25 18:46:22 +00:00
Code Issues 25 Releases Wiki Activity
a195ec847e
django/docs
History
Andrew Godwin a195ec847e [1.7.x] Improve migrations/schema docs
2014-04-14 18:09:48 -04: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] Fixed #22412 -- More nuanced advice re template filters and exceptions. 2014-04-10 06:19:02 -04:00
internals [1.7.x] Add some syncdb deprecation stuff into the deprecation doc 2014-03-25 20:02:07 -04:00
intro [1.7.x] Added Python 3.4 to list of supported version in docs/intro/install.txt 2014-04-08 11:13:36 -04:00
man
misc
ref [1.7.x] Improve migrations/schema docs 2014-04-14 18:09:48 -04:00
releases [1.7.x] Fixed #21760 -- prefetch_related used an inefficient query for reverse FK. 2014-04-13 00:51:38 +07:00
topics [1.7.x] Improve migrations/schema docs 2014-04-14 18:09:48 -04:00
conf.py Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05: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 Updated spelling_wordlist. 2014-03-11 08:11:16 -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/