1
0
mirror of https://github.com/django/django.git synced 2024-12-27 19:46:22 +00:00
django/docs
2015-06-05 12:23:08 -04:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq [1.8.x] Removed Django 1.6 from the Python version chart. 2015-04-02 14:22:29 -04:00
howto [1.8.x] Fixed #24630 -- Clarified docs about RunPython transactions. 2015-05-17 18:51:40 -04:00
internals [1.8.x] Capitalized "Python" in docs. 2015-06-05 08:38:43 -04:00
intro [1.8.x] Made minor edits to docs/intro/tutorial01.text 2015-05-19 12:33:38 -04:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc
ref [1.8.x] Fixed #22571 -- Added clarification about auto_now_add=True 2015-06-05 10:04:24 -04:00
releases [1.8.x] Fixed #24924 -- Join promotion for multiple Case expressions 2015-06-05 12:23:08 -04:00
topics [1.8.x] Capitalized "Python" in docs. 2015-06-05 08:38:43 -04:00
conf.py [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt [1.8.x] Fixed #24839 -- Removed references to deprecated contrib.webdesign. 2015-05-22 09:40:01 -04:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist [1.8.x] Updated capitalization in the word "JavaScript" for consistency 2015-05-01 13:27: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/