1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
2015-01-18 16:07:44 -05:00
..
_ext Fixed #23968 -- Replaced list comprehension with generators and dict comprehension 2014-12-08 07:58:23 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
howto [1.8.x] Standardized indentation in docs/howto/custom-management-commands.txt. 2015-01-17 13:27:59 -05:00
internals [1.8.x] Clarified deprecation of forms.forms.get_declared_fields(); refs #19617. 2015-01-18 16:07:44 -05:00
intro [1.8.x] Updated tutorial 1 with actual migrate output. 2015-01-17 10:46:27 -05:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc
ref [1.8.x] Clarified a contrib.sites deprecation and added to 1.7 release notes. 2015-01-18 13:44:53 -05:00
releases [1.8.x] Clarified deprecation of forms.forms.get_declared_fields(); refs #19617. 2015-01-18 16:07:44 -05:00
topics [1.8.x] Fixed a typo in the test responses docs. 2015-01-16 18:24:44 -05:00
conf.py [1.8.x] Bumped django_next_version in docs config. 2015-01-16 18:30:49 -05:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Fixed #24031 -- Added CASE expressions to the ORM. 2015-01-12 18:15:34 -05: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 Fixed DoS possibility in ModelMultipleChoiceField. 2015-01-13 13:03:06 -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/