1
0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
django/docs
2014-09-08 13:22:15 -04: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 typo in docs/howto/custom-lookups.txt. 2014-09-07 11:29:20 +02:00
internals Added the inaugural technical board. 2014-09-06 19:13:29 -04:00
intro Fixed #23438 -- Added snippet & imports to docs/intro/overview.txt. 2014-09-06 07:31:36 -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 #23281 -- Added "concrete model" to glossary. 2014-09-08 08:45:47 -04:00
releases Fixed #22951 -- Checked for types during deep_deconstruct migration serialization process. 2014-09-08 07:39:09 -04:00
topics Fixed #23307 -- Clarified the way max_num limits the output of formsets. 2014-09-08 13:22:15 -04: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 Introduced a technical board. 2014-08-01 14:41:24 +02:00
make.bat
Makefile
README
spelling_wordlist Added words to spelling_wordlist. 2014-08-26 09:44:07 -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/