django/docs
Tim Graham 36c83a0d1e [1.10.x] Updated links to the current version of PostGIS docs.
Backport of cc282fa731 from master
2016-09-30 09:40:39 -04: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] Added Django 1.11, 2.0 to Python version support table. 2016-08-26 17:23:09 -04:00
howto [1.10.x] Fixed typos in docs/howto/deployment/checklist.txt. 2016-09-29 20:00:05 -04:00
internals [1.10.x] Fixed -- Added tips for installing test suite dependencies. 2016-08-09 18:41:32 -04:00
intro [1.10.x] Fixed -- Explained where PollsConfig comes from in tutorial 2. 2016-09-07 14:16:33 -04:00
man [1.10.x] Updated man page for Django 1.10 alpha. 2016-05-20 06:49:36 -04:00
misc Fixed -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref [1.10.x] Updated links to the current version of PostGIS docs. 2016-09-30 09:40:39 -04:00
releases [1.10.x] Updated links to the current version of PostGIS docs. 2016-09-30 09:40:39 -04:00
topics [1.10.x] Updated links to the current version of MySQL docs. 2016-09-30 09:15:49 -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.10.x] Added a CVE role for Sphinx. 2016-09-26 18:22:14 -04:00
contents.txt Fixed -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Refs -- Added full text search to contrib.postgres. 2016-04-22 10:44:37 +01:00
make.bat Fixed - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.10.x] Normalized spelling of "Web server/page" in docs. 2016-09-29 19:52:53 -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/