mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
Code Issues Releases Wiki Activity
a918f8b089
django/docs
History
Tim Graham a918f8b089 Documented that forms.Field.help_text isn't HTML-escaped.
2015-11-24 10:17:16 -05:00
..
_ext Removed a docs workaround for an old Sphinx version. 2015-11-16 18:49:32 -05:00
_theme Made doc icon's edges smooth. 2015-11-14 08:11:47 -05:00
faq Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
howto Fixed #25526 -- Documented how to output colored text in custom management commands. 2015-11-17 15:06:13 -05:00
internals Fixed #25764 -- Added support for serialization of enum.Enum in migrations. 2015-11-19 17:21:12 -05:00
intro Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
man Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:31:11 -04:00
misc Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
ref Documented that forms.Field.help_text isn't HTML-escaped. 2015-11-24 10:17:16 -05:00
releases Refs #25786 -- Added tests/release notes for set_FOO_order() crash with order_with_respect_to referencing OneToOneField pk. 2015-11-23 11:33:13 -05:00
topics Fixed #25764 -- Added support for serialization of enum.Enum in migrations. 2015-11-19 17:21:12 -05:00
conf.py Removed a docs workaround for an old Sphinx version. 2015-11-16 18:49:32 -05:00
contents.txt
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Changed section title from "Model syntax" to "Introduction to models". 2015-11-16 09:53:57 -05:00
make.bat
Makefile
README
spelling_wordlist Fixed #25654 -- Added the GEOSGeometry.unary_union property. 2015-11-18 19:17:16 -05: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/