mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-09-13 14:06:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Tim Graham f2969c7e02 [1.5.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 
Backport of a3a59a3197 from master
2013-07-31 09:26:23 -04:00
..
_ext [1.5.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:26:23 -04:00
_theme/djangodocs
faq [1.5.x] Fixed #15379 - Added "how to cite Django" to FAQ. 2013-03-29 16:50:33 -04:00
howto [1.5.x] Fixed #20756 -- Typo in uWSGI docs. 2013-07-17 06:51:42 -04:00
internals [1.5.x] Added a missing test requirement in the docs; refs #19196 2013-07-10 12:10:26 -04:00
intro [1.5.x] Fixed #20763 -- Typo in tutorial 3. 2013-07-18 08:05:06 -04:00
man
misc [1.5.X] Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:20:46 -05:00
ref [1.5.x] Fixed #20779 -- Documented AdminSite.app_index_template; refs #8498. 2013-07-31 07:09:45 -04:00
releases [1.5.x] Fixed #18944 -- Documented PasswordResetForm's from_email argument as a backwards incompatible change for 1.3 2013-07-08 15:06:37 -04:00
topics [1.5.x] Misc doc cleanups. 2013-07-29 07:06:34 -04:00
conf.py [1.5.x] Allow build of translated documentation 2013-06-08 16:14:45 +02:00
contents.txt
glossary.txt
index.txt [1.5.x] Fixed #19897 - Updated static files howto. 2013-03-30 07:12:37 -04:00
make.bat
Makefile [1.5.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:50 -04:00
README

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/