1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2014-09-21 16:00:19 +02:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Fixed #23016 -- Updated FAQs per Aymeric's suggestions. 2014-08-12 13:46:10 -04:00
howto Fixed #23530 -- Specified PyYAML requirement in initial-data.txt 2014-09-21 16:00:19 +02:00
internals Moved some people to "past team members". 2014-09-16 13:12:33 -04:00
intro Fixed #23491 -- Clarified tutorial 3. 2014-09-17 08:37:27 -04:00
man Replaced django-admin.py with django-admin in the man page. 2014-07-31 23:46:49 +02:00
misc
ref Fixed #23488 -- Added AnonymousUser.get_username(). 2014-09-18 10:48:28 -04:00
releases Fixed a formatting issue in the 1.7 release notes. 2014-09-19 13:05:20 +02:00
topics Small fixes in templates topic guide. 2014-09-20 19:23:22 +02:00
conf.py Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
contents.txt
glossary.txt Fixed #23281 -- Added "concrete model" to glossary. 2014-09-08 08:45:47 -04:00
index.txt Fixed #17101 -- Integrated django-secure and added check --deploy option 2014-09-12 15:05:23 -04:00
make.bat
Makefile
README
spelling_wordlist Fixed typo in docs/internals/roles.txt and added words to spelling_wordlist. 2014-09-16 08:38:51 -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 ``sudo 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/