django/docs
Tim Graham 2c11002fec [1.9.x] Refs #25527 -- Removed redundant doc heading link that leads to a warning when generating PDF.
Backport of 25f287f6b2 from master
2015-10-07 19:36:57 -04:00
..
_ext Removed obsolete literals_to_xrefs.py script. 2015-06-15 10:22:18 -04:00
_theme Added white-space: pre-wrap; to docs code blocks to match docs.dp.com. 2015-06-22 15:56:06 -04:00
faq Refs #14091 -- Fixed connection.queries on SQLite. 2015-09-17 23:01:33 +02:00
howto [1.9.x] Fixed #25515 -- Documented the return value of BaseCommand.handle() 2015-10-06 15:09:55 -04:00
internals [1.9.x] Fixed #25466 -- Added backwards compatibility aliases for LoaderOrigin and StringOrigin. 2015-09-29 19:20:11 -04:00
intro [1.9.x] Made a couple tutorial corrections for Django 1.9. 2015-10-01 15:19:10 -04:00
man Updated man page for Django 1.9 alpha. 2015-09-23 19:28:55 -04:00
misc Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
ref [1.9.x] Added some function links in translation docs 2015-10-07 17:31:28 +02:00
releases [1.9.x] Fixed #25503 -- Fixed system check crash on ForeignKey to abstract model. 2015-10-06 19:23:53 -04:00
topics [1.9.x] Refs #25527 -- Removed redundant doc heading link that leads to a warning when generating PDF. 2015-10-07 19:36:57 -04: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 [1.9.x] Bumped django_next_version in docs config. 2015-09-23 19:36:23 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:41:39 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Added "readded" to the docs wordlist. 2015-09-21 17:07:32 -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 ``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/