mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
03306a187e
django/docs
History
Tim Graham 03306a187e Declared Sphinx extensions safe for parallel reading.
2016-01-13 11:33:25 -05:00
..
_ext Declared Sphinx extensions safe for parallel reading. 2016-01-13 11:33:25 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Fixed #25881 -- Marked Python 3.2 in Django 1.8 as unsupported at the end of 2016. 2015-12-08 10:55:49 -05:00
howto Removed an unncessary docs cross-reference for call_command(). 2016-01-12 18:01:29 -05:00
internals Added missing period to "etc.". 2016-01-11 18:05:15 -05:00
intro Added a missing import in tutorial 3. 2016-01-02 09:39:25 -05:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
ref Refs #25769 -- Updated docs to reflect get_version() uses PEP 0440. 2016-01-13 07:06:34 -05:00
releases Refs #26071 -- Added test for __in lookup in a Case expression. 2016-01-13 08:56:36 -05:00
topics Added missing period to "etc.". 2016-01-11 18:05:15 -05:00
conf.py Refs #25769 -- Updated docs to reflect get_version() uses PEP 0440. 2016-01-13 07:06:34 -05:00
contents.txt
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Fixed #26003 -- Added "how the documentation is organized" sections. 2015-12-31 11:35:00 -05:00
make.bat
Makefile
README
spelling_wordlist Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05: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/