1
0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
django/docs
2018-05-12 19:37:42 +02: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 Alphabetized imports in various docs. 2018-05-12 19:37:42 +02:00
internals Fixed #29363 -- Added SimpleTestCase.assertWarnsMessage(). 2018-05-09 11:40:28 -04:00
intro Alphabetized imports in various docs. 2018-05-12 19:37:42 +02:00
man Updated man page for Django 2.0 alpha. 2017-09-22 12:28:56 -04:00
misc
ref Alphabetized imports in various docs. 2018-05-12 19:37:42 +02:00
releases Fixed #27629 -- Added router.allow_relation() calls for assignments between unsaved model instances. 2018-05-10 20:42:44 -04:00
topics Alphabetized imports in various docs. 2018-05-12 19:37:42 +02:00
conf.py Updated intersphinx_mapping URL for sphinx. 2018-04-04 11:32:14 -04:00
contents.txt
glossary.txt
index.txt Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat
Makefile
README
spelling_wordlist Fixed #29360 -- Removed Fabric examples in docs. 2018-04-29 22:12:40 -04: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/