1
0
mirror of https://github.com/django/django.git synced 2024-12-24 18:16:19 +00:00
django/docs
2015-05-21 20:45:51 -04:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -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 Removed Django 1.6 from the Python version chart. 2015-04-02 14:21:01 -04:00
howto Fixed #17085, #24783 -- Refactored template library registration. 2015-05-21 09:12:06 -05:00
internals Removed obsolete distros@vs.openwall.org security notification. 2015-05-21 19:22:58 -04:00
intro Made minor edits to docs/intro/tutorial01.text 2015-05-19 12:32:23 -04:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc
ref Cosmetic edits and minor fixes to docs/ref/contrib/admin/index.txt 2015-05-21 20:23:26 -04:00
releases Fixed #17085, #24783 -- Refactored template library registration. 2015-05-21 09:12:06 -05:00
topics Enhanced registration/login.html example template. 2015-05-21 20:45:51 -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 Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
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 Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Updated capitalization in the word "JavaScript" for consistency 2015-05-01 13:26:42 -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/