django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Tim Graham 91c02ca7ba Fixed a heading typo in docs/releases/1.11.txt		2016-06-22 11:16:18 -04:00
..
_ext
_theme
faq
howto	Fixed broken links in docs and comments.	2016-06-15 21:20:23 -04:00
internals	Fixed #26701 -- Replaced /newticket links to Trac with /.	2016-06-03 08:48:12 -04:00
intro	Fixed #26747 -- Used more specific assertions in the Django test suite.	2016-06-16 14:19:18 -04:00
man
misc
ref	Fixed #25940 -- Added OGRGeometry.from_gml() and GEOSGeometry.from_gml().	2016-06-21 15:46:27 -04:00
releases	Fixed a heading typo in docs/releases/1.11.txt	2016-06-22 11:16:18 -04:00
topics	Fixed typo in docs/topics/logging.txt	2016-06-22 06:38:34 -04:00
conf.py	Ignored new warnings when building the docs with Sphinx 1.4.	2016-06-01 11:03:41 -04:00
contents.txt
glossary.txt
index.txt	Refs #3254 -- Added full text search to contrib.postgres.	2016-04-22 10:44:37 +01:00
make.bat
Makefile
README
spelling_wordlist	Refs #26666 -- Added ALLOWED_HOSTS validation when running tests.	2016-06-20 11:07:46 -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/