0
0
mirror of https://github.com/django/django.git synced 2024-11-25 07:59:34 +01:00
django/docs
2016-07-06 17:11:59 +02:00
..
_ext Added copy-to-clipboard support for all code snippets 2016-07-06 17:11:59 +02:00
_theme
faq
howto Fixed broken links in docs and comments. 2016-06-15 21:20:23 -04:00
internals Refs #17209 -- Added LoginView and LogoutView class-based views 2016-06-24 10:45:13 +02:00
intro Fixed #26829 -- Simplified version detection command in tutorial 2016-07-02 12:52:36 +02:00
man
misc
ref Fixed #25461 -- Corrected meta API code examples to account for MTI. 2016-07-06 09:28:37 -04:00
releases Fixed #18682 -- Expanded explanation in stale content type deletion. (#6869) 2016-07-03 15:55:14 +02:00
topics Fixed typo in docs/topics/class-based-views/generic-display.txt 2016-07-06 08:48:43 -04:00
conf.py
contents.txt
glossary.txt
index.txt Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
Makefile
README
spelling_wordlist Refs #26666 -- Added ALLOWED_HOSTS validation when running tests. 2016-06-20 11:07:46 -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/