mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
Code Issues 25 Releases Wiki Activity
cdd44dca45
django/docs
History
James Bennett cdd44dca45 Update my committer bio since I work somewhere else now. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16634 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-08-21 15:45:09 +00:00
..
_ext
_theme/djangodocs
faq
howto Fixed #15252 -- Added static template tag and CachedStaticFilesStorage to staticfiles contrib app. 2011-08-11 14:07:39 +00:00
internals Update my committer bio since I work somewhere else now. 2011-08-21 15:45:09 +00:00
intro Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
man
misc
obsolete
ref Fixed #16602 - Added forms.widgets TOC links to docs; thanks kencochrane. 2011-08-21 11:51:48 +00:00
releases Fixed #16621 -- Fixed lots of typos in the docs. Thanks, Bernhard Essl. 2011-08-13 11:58:19 +00:00
topics Fixed #16610 - Added more docs for template contexts in contrib.auth views; thanks Elvard! 2011-08-21 10:37:02 +00:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
Makefile
README Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +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`` (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.pocoo.org/