1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2015-07-30 10:12:41 -04:00
..
_ext
_theme
faq
howto Fixed #25178 -- Added DEFAULT_FROM_EMAIL to deployment checklist. 2015-07-28 09:44:08 -04:00
internals Fixed #25190 -- Deprecated callable_obj parameter to assertRaisesMessage(). 2015-07-30 10:12:41 -04:00
intro Fixed #21127 -- Started deprecation toward requiring on_delete for ForeignKey/OneToOneField 2015-07-27 18:28:13 -04:00
man
misc Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
ref Refs #18556 -- Fixed a typo in the related manager add() method docs. 2015-07-27 22:50:13 -04:00
releases Fixed #25190 -- Deprecated callable_obj parameter to assertRaisesMessage(). 2015-07-30 10:12:41 -04:00
topics Fixed #25190 -- Deprecated callable_obj parameter to assertRaisesMessage(). 2015-07-30 10:12:41 -04:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Added 'bookmarklet' to spelling word list. 2015-07-13 08:48:56 -04: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/