1
0
mirror of https://github.com/django/django.git synced 2024-12-27 19:46:22 +00:00
django/docs
2015-04-08 08:36:41 -04:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -05:00
_theme
faq [1.8.x] Removed Django 1.6 from the Python version chart. 2015-04-02 14:22:29 -04:00
howto [1.8.x] Fixed #24602 -- Removed obsolete reference to __metaclass__ in custom model fields docs. 2015-04-08 08:36:41 -04:00
internals [1.8.x] Added link to download page to find supported versions. 2015-04-04 08:00:30 -04:00
intro [1.8.x] Fixed typo in docs/intro/tutorial02.txt 2015-04-07 07:41:46 -04:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc
ref [1.8.x] Fixed #24600 -- Fixed inaccurate example in template Context docs. 2015-04-08 07:30:28 -04:00
releases [1.8.x] Fixed #24513 -- Made sure a model is only rendered once during reloads 2015-04-07 14:56:33 +02:00
topics [1.8.x] Fixed #24429 -- Doc'ed that Django 1.8 doesn't require an integer PK for custom user models. 2015-04-07 10:47:48 -04:00
conf.py [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
contents.txt
glossary.txt
index.txt [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -05:00
make.bat
Makefile
README
spelling_wordlist [1.8.x] Reverted "Fixed #24325 -- Documented change in ModelForm.save() foreign key access." 2015-02-24 11:51:10 -05: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 ``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/