0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
Ramiro Morales 5866a49369 Note about static files dirs paths on Windows.
Added it to the settings reference. We used to have it in comment form
in our old, bigger default project template settings.py file.
2013-09-28 20:32:55 -03:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs Fixed #21702 -- Added different bullet styles for nested lists. 2013-09-23 07:37:09 -04:00
faq
howto Updated a code block to use the emphasize-lines Sphinx option 2013-09-25 11:39:38 -04:00
internals Fixed #20439 -- Started deprecation of IPAddressField 2013-09-28 10:55:32 +02:00
intro Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc
ref Note about static files dirs paths on Windows. 2013-09-28 20:32:55 -03:00
releases Fixed #20439 -- Started deprecation of IPAddressField 2013-09-28 10:55:32 +02:00
topics Fixed #17671 - Cursors are now context managers. 2013-09-25 21:47:26 +03:00
conf.py Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03:00
contents.txt
glossary.txt
index.txt Fixed #20877 -- added a performance optimization guide 2013-09-20 23:21:49 +01:00
make.bat
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03: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/