django

mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00

History

Tim Graham 73ff4498aa Removed some tabs in the docs.		2014-08-08 13:59:02 -04:00
..
_ext	Fixed #23067 -- Updated docs to use django-admin	2014-07-30 14:14:03 -04:00
_theme	Made docs CSS for versionchanged/added more similar to docs.djangoproject.com.	2014-06-30 18:38:30 -04:00
faq	Renamed "committers" to "team".	2014-08-01 14:41:24 +02:00
howto	Fixed #23257 -- Updated docs for new django-jython release.	2014-08-08 12:31:56 -04:00
internals	Fixed #23252 : Call out removed features in release notes.	2014-08-07 14:14:12 +10:00
intro	Updated links for continous integration server.	2014-08-05 07:28:04 -04:00
man	Replaced django-admin.py with django-admin in the man page.	2014-07-31 23:46:49 +02:00
misc
ref	Removed some tabs in the docs.	2014-08-08 13:59:02 -04:00
releases	Fixed #23252 : Call out removed features in release notes.	2014-08-07 14:14:12 +10:00
topics	Removed a doc reference to the deprecated `mimetype` kwarg.	2014-08-06 22:15:54 -04:00
conf.py	Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode.	2014-06-07 08:54:54 -04:00
contents.txt
glossary.txt
index.txt	Introduced a technical board.	2014-08-01 14:41:24 +02:00
make.bat
Makefile
README
spelling_wordlist	Fixed #22796 -- Added a more basic explanations of forms.	2014-06-24 14:55:22 -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/