mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-23 21:25:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Tom Christie 9fa6aa9534 [1.5.x] Formatting tweaks. 
(cherry picked from commit 3f2fc2f41a)
2012-11-17 21:31:21 +01:00
..
_ext
_theme/djangodocs
faq [1.5.x] Documented minimal python 3.2 version. 2012-11-02 10:52:15 +01:00
howto [1.5.x] Fixed #19310 -- changed method docs formatting for custom file storage docs 2012-11-17 07:13:37 -08:00
internals [1.5.X] Fixed #16779 - Added a contributing tutorial 2012-11-17 14:12:18 -05:00
intro [1.5.X] Fixed #16779 - Added a contributing tutorial 2012-11-17 14:12:18 -05:00
man
misc Replaced mentions of Subversion by Git in docs 2012-10-14 23:03:01 +02:00
ref [1.5.x] Formatting tweaks. 2012-11-17 21:31:21 +01:00
releases [1.5.x] Fixed #18985 -- made DeprecationWarnings loud 2012-11-16 17:08:02 -08:00
topics [1.5.x] fixed a broken link in the docs. Backport of 1e34fd3c03 2012-11-13 14:49:08 -08:00
conf.py [1.5.x] Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:03:52 +01:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt
index.txt [1.5.X] Fixed #16779 - Added a contributing tutorial 2012-11-17 14:12:18 -05:00
make.bat [1.5.x] Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:03:52 +01:00
Makefile [1.5.x] Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:03:52 +01:00
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/