mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-28 03:55:50 +00:00
Code Issues 30 Releases Wiki Activity
e2acbfb69b
django/docs
History
Luke e2acbfb69b [1.8.x] Fixed mistake in Model.from_db() example. 
Backport of fd869cceac from master
2015-07-03 09:09:38 -04:00
..
_ext [1.8.x] Removed obsolete literals_to_xrefs.py script. 2015-06-15 13:01:32 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq [1.8.x] Simplified wording of Python support policy. 2015-06-22 12:20:20 -04:00
howto [1.8.x] Fixed typo in writing migrations docs 2015-07-01 09:17:10 +02:00
internals [1.8.x] Fixed #25056 -- Documented minimum version of jinja2 for testing. 2015-07-03 08:22:34 -04:00
intro [1.8.x] Added Python version support policy 2015-06-18 12:23: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 mistake in Model.from_db() example. 2015-07-03 09:09:38 -04:00
releases [1.8.x] Fixed #25038 -- Reverted incorrect documentation about inspectdb introspecting views. 2015-06-30 14:25:45 -04:00
topics [1.8.x] Renamed RemovedInDjango20Warning to RemovedInDjango110Warning. 2015-06-23 07:22:16 -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 Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt [1.8.x] Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:44:07 -04:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist [1.8.x] Fixed #25016 -- Reallowed non-ASCII values for ForeignKey.related_name on Python 3. 2015-06-26 08:35:13 -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 ``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/