django

mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00

History

Peter Inglesby b6323302e0 [1.8.x] Fixed docs typo Backport of `a8f1c70dce` from master		2015-02-07 18:47:17 +01:00
..
_ext	[1.8.x] Fixed E265 comment style	2015-02-06 09:35:08 -05:00
_theme
faq	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
howto	[1.8.x] Added a "Writing migrations" how-to.	2015-02-03 13:46:56 -05:00
internals	[1.8.x] Fixed docs typo	2015-02-07 18:47:17 +01:00
intro	[1.8.x] Updated tutorial 1 with actual migrate output.	2015-01-17 10:46:27 -05:00
man	[1.8.x] Removed gather_profile_stats.py	2015-02-06 08:55:02 -05:00
misc
ref	[1.8.x] Improved nested ArrayField example	2015-02-05 11:35:23 +01:00
releases	[1.8.x] Fixed #23617 -- Added get_pk_value_on_save()	2015-02-03 09:25:55 -05:00
topics	[1.8.x] Removed inaccurate sentence about PO files in translation docs.	2015-02-06 07:46:14 -05:00
conf.py	[1.8.x] Fixed E265 comment style	2015-02-06 09:35:08 -05:00
contents.txt
glossary.txt	Fixed some intersphinx references.	2014-10-16 20:00:17 -04:00
index.txt	[1.8.x] Added a "Writing migrations" how-to.	2015-02-03 13:46:56 -05:00
make.bat
Makefile	Added an "htmlview" target to open docs after building them.	2014-12-08 07:23:34 -05:00
README
spelling_wordlist	Fixed DoS possibility in ModelMultipleChoiceField.	2015-01-13 13:03:06 -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/