1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2018-03-28 13:25:03 -04:00
..
_ext Bumped minimum Sphinx version to 1.6.0. 2018-03-22 20:30:03 -04:00
_theme Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
faq
howto Replaced 'python -Wall' with 'python -Wa'. 2018-03-28 13:25:03 -04:00
internals Replaced 'python -Wall' with 'python -Wa'. 2018-03-28 13:25:03 -04:00
intro isorted import statements in tutorial example 2018-03-22 08:53:56 +01:00
man
misc
ref Fixed #29148 -- Doc'd how to use get_or_create() with Q objects. 2018-03-28 10:46:34 -04:00
releases Fixed #23406 -- Allowed migrations to be loaded from .pyc files. 2018-03-23 13:20:38 -04:00
topics Replaced 'python -Wall' with 'python -Wa'. 2018-03-28 13:25:03 -04:00
conf.py Bumped minimum Sphinx version to 1.6.0. 2018-03-22 20:30:03 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist Fixed #28960 -- Added GEOSGeometry.buffer_with_style(). 2018-02-10 19:45:58 -05:00

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/