django

mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00

History

Sébastien Fievet 0f90f741de Fixed typo in docs/topics/checks.txt.		2014-09-05 14:28:46 -04:00
..
_ext
_theme
faq
howto	Fixed #18757 , #14462 , #21565 -- Reworked database-python type conversions	2014-09-03 20:36:03 +01:00
internals	Limited lines to 119 characters in django/	2014-09-05 09:22:16 -04:00
intro	Fixed #23362 -- Clarified "database columns as attributes" in tutorial.	2014-08-26 10:00:33 -04:00
man
misc
ref	Added missing periods in docs/ref/checks.txt.	2014-09-05 12:30:24 -04:00
releases	Revert "Fixed #23384 -- Allowed overriding part of a dictionary-type setting"	2014-09-05 20:06:02 +02:00
topics	Fixed typo in docs/topics/checks.txt.	2014-09-05 14:28:46 -04:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist	Added words to spelling_wordlist.	2014-08-26 09:44:07 -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/