django/docs
Tim Graham e80f59e3bb Added showmigrations to spelling wordlist. 2015-01-01 09:18:57 -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 Revert "Updated some docs for the delayed deprecation of legacy table creation; refs #22340." 2014-12-30 11:50:50 -05:00
internals Fixed #23359 -- Added showmigrations command to list migrations and plan. 2014-12-31 14:14:28 -05:00
intro Deprecated TEMPLATE_DIRS. 2014-12-28 17:02:30 +01:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed typo in docs/ref/contrib/admin/index.txt. 2015-01-01 08:18:39 -05:00
releases Fixed #23366 -- Fixed a crash with the migrate --list command. 2014-12-31 17:26:15 -05:00
topics Fixed #12118 -- Added shared cache support to SQLite in-memory testing. 2014-12-30 10:14:33 -05:00
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
conf.py Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Fixed #23753 -- Added a suite of SQL Functions 2014-12-27 15:27:27 +11:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Added showmigrations to spelling wordlist. 2015-01-01 09:18:57 -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/