1
0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
django/docs
2014-04-25 12:29:33 -05:00
..
_ext
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Fixed queries that may return unexpected results on MySQL due to typecasting. 2014-04-21 18:11:26 -04:00
internals Renamed Transifex project from django-core to django 2014-04-24 11:38:18 +02:00
intro Fixed #22472 -- Clarified meaning of dots in tutorial 4 code block. 2014-04-18 12:10:46 -04:00
man
misc
ref Fixed a confusing heading in applications docs. 2014-04-25 17:39:49 +02:00
releases Fixed a confusing heading in applications docs. 2014-04-25 17:39:49 +02:00
topics Fixed #22517, "view prefix" still referenced in urlconf docs 2014-04-25 12:29:33 -05:00
conf.py Bumped version to reflect master is now pre-1.8. 2014-03-21 06:17:14 -04: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 Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03:00

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/