django

mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00

History

Preston Holmes 2cb48fffd4 Removed redundant docs addition across two commits `d5c3c45f2f` `a70492e6b5`		2012-11-04 19:12:44 -08:00
..
_ext
_theme/djangodocs
faq	Merge pull request #485 from asparagui/add_period	2012-11-02 16:17:25 -07:00
howto	Fixed #19208 -- Docs for mod_wsgi daemon mode	2012-10-29 21:39:12 +01:00
internals	Added a note and link to CLA from contributing docs	2012-11-04 12:25:48 -08:00
intro	Fixed #19216 - Switched to user level installation in apps tutorial.	2012-10-31 19:56:53 -04:00
man
misc	Replaced mentions of Subversion by Git in docs	2012-10-14 23:03:01 +02:00
ref	Removed redundant docs addition across two commits	2012-11-04 19:12:44 -08:00
releases	Corrected a typo that inadvertently made its way into the docs.	2012-11-04 15:44:20 -08:00
topics	Fixed #6234 -- Removed obsolete note about json and ensure_ascii	2012-11-03 23:53:51 +01:00
conf.py	Ensure that version detection in docs from `373df56d` uses the right Django copy.	2012-10-28 18:18:09 -03:00
contents.txt	Removed an obsolete documentation page about admin style customization.	2012-09-10 17:19:35 -07:00
glossary.txt
index.txt	Fixed #16671 - Added a tutorial on reuseable apps	2012-10-30 18:40:21 -04:00
make.bat
Makefile
README	Fixed #18928 . Tightened language in docs/README.	2012-09-08 11:11:37 +05:30

README

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