django

mirror of https://github.com/django/django.git synced 2025-01-12 19:37:06 +00:00

History

Carl Meyer b2dcec228a Fixed broken link. git-svn-id: http://code.djangoproject.com/svn/django/trunk@17683 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-03-12 17:22:22 +00:00
..
_ext
_theme/djangodocs
faq
howto	Fixed #17842 - Typo in uWsgi docs; thanks mitnk.	2012-03-10 10:03:33 +00:00
internals	Fixed broken link.	2012-03-12 17:22:22 +00:00
intro	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +00:00
man
misc
obsolete
ref	Fixed an inappropriate repetition. Thanks DanGer for the report.	2012-03-11 11:49:38 +00:00
releases	Linked to the FAQ from the release notes.	2012-03-03 22:54:55 +00:00
topics	Fixed a couple of typos in testing document.	2012-03-11 19:49:19 +00:00
conf.py	Bump for 1.4 RC 1.	2012-03-05 17:22:23 +00:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +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:

* 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.pocoo.org/