django/docs
Tim Graham 59bbacf88d [1.10.x] Updated "fork Django on GitHub" link.
Backport of b741fe397a from master
2016-11-04 05:48:54 +01:00
..
_ext [1.10.x] Added a CVE role for Sphinx. 2016-09-26 18:22:14 -04:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq [1.10.x] Fixed #27425 -- Removed obsolete "developers for hire" FAQ. 2016-11-03 12:50:44 +01:00
howto [1.10.x] Replaced Outputting PDF's "Further Resources" with a link to Django Packages. 2016-10-25 11:59:52 -04:00
internals [1.10.x] Updated "fork Django on GitHub" link. 2016-11-04 05:48:54 +01:00
intro [1.10.x] Updated "fork Django on GitHub" link. 2016-11-04 05:48:54 +01:00
man [1.10.x] Updated man page for Django 1.10 alpha. 2016-05-20 06:49:36 -04:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref [1.10.x] Fixed CVE-2016-9014 -- Validated Host header when DEBUG=True. 2016-11-01 09:36:44 -04:00
releases [1.10.x] Added CVE-2016-9013,14 to the security release archive. 2016-11-01 10:48:41 -04:00
topics [1.10.x] Fixed typo in docs/topics/testing/tools.txt. 2016-11-04 05:13:10 +01: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.10.x] Added a CVE role for Sphinx. 2016-09-26 18:22:14 -04:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Refs #3254 -- Added full text search to contrib.postgres. 2016-04-22 10:44:37 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.10.x] Fixed #27410 -- Clarified when static files is enabled in STATIC_ROOT docs. 2016-10-31 15:19:21 -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/