mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 16 Releases Wiki Activity
django/docs
History
Luke Plant 66fd824ee0 Fixed djangodocs Sphinx extension to work with latest Sphinx 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16231 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 		2011-05-15 23:02:36 +00:00
..
_ext Fixed djangodocs Sphinx extension to work with latest Sphinx 2011-05-15 23:02:36 +00:00
_theme/djangodocs
…
faq Fixed #14091 - be more correct about logging queries in connection.queries. 2011-04-22 12:14:54 +00:00
howto Fixed #16014 -- numerous documentation typos -- thanks psmith. 2011-05-13 04:33:42 +00:00
internals Fixed #16014 -- numerous documentation typos -- thanks psmith. 2011-05-13 04:33:42 +00:00
intro Fixed #16014 -- numerous documentation typos -- thanks psmith. 2011-05-13 04:33:42 +00:00
man
…
misc Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt 2011-04-01 16:10:22 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #15769 - Documented FormWizard's initial argument; thanks aimaz for the suggestion; jrothenbuhler for the patch. 2011-05-15 19:11:57 +00:00
releases Edited docs/releases/1.4.txt changes from [16124] 2011-05-14 17:58:32 +00:00
topics Removed last vestiges of references to technical messages from documentation. 2011-05-14 12:28:36 +00:00
Makefile
…
README
…
conf.py Bumped django_next_version so that "New in Django 1.3" links appear correctly. 2011-03-24 09:40:50 +00:00
contents.txt
…
glossary.txt Minor markup and organization fixes to docs to correct Sphinx errors. 2011-03-22 14:35:14 +00:00
index.txt Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt 2011-04-01 16:10:22 +00:00

README 

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` 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.pocoo.org/