1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2015-04-09 12:15:50 -04:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme
faq Removed Django 1.6 from the Python version chart. 2015-04-02 14:21:01 -04:00
howto Fixed #24602 -- Removed obsolete reference to __metaclass__ in custom model fields docs. 2015-04-08 08:35:35 -04:00
internals Refs #24568 -- Added Read the Docs step to the release checklist. 2015-04-09 10:07:20 -04:00
intro Fixed typo in docs/intro/tutorial02.txt 2015-04-07 07:41:05 -04:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc
ref Fixed #24560 -- Added a --dry-run mode to the createcachetable command. 2015-04-09 12:15:50 -04:00
releases Fixed #24560 -- Added a --dry-run mode to the createcachetable command. 2015-04-09 12:15:50 -04:00
topics Fixed #24560 -- Added a --dry-run mode to the createcachetable command. 2015-04-09 12:15:50 -04:00
conf.py Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
contents.txt
glossary.txt
index.txt Fixed #23814 -- Documented apps refactored out of Django. 2015-03-25 08:46:23 -04:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README
spelling_wordlist Refs #24568 -- Added Read the Docs step to the release checklist. 2015-04-09 10:07:20 -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/