mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 13:44:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Preston Holmes 19710955e4 [1.4.x] Added examples of using startproject/app with URLs 
thanks to Brent O'Connor for the idea and intial docs
2012-11-21 22:08:31 -08:00
..
_ext Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed 2012-01-11 10:19:05 +00:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq [1.4.X] Fixed #17511 - Removed reference to deprecated "reset" management command in FAQ; thanks voxpuibr@ for the report. 2012-06-27 18:56:04 -04:00
howto [1.4.x] Fixed #19208 -- Docs for mod_wsgi daemon mode 2012-10-29 21:40:32 +01:00
internals [1.4.X] Fixed #16817 - Added a guide of code coverage to contributing docs. 2012-10-11 06:14:24 -04:00
intro [1.4.x] Fixed some broken links in 1.4 docs 2012-09-08 15:21:13 -04:00
man [1.4.X] Fix lintian error in manpages. 2012-03-29 15:08:38 +00:00
misc Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref [1.4.x] Added examples of using startproject/app with URLs 2012-11-21 22:08:31 -08:00
releases Added 1.4.2 release notes 2012-10-21 07:50:30 -07:00
topics Fixed #19225 -- Typo in shortcuts docs. 2012-11-02 09:30:42 +01:00
conf.py [1.4.x] Bump version numbers for security release. 2012-10-17 17:15:49 -05:00
contents.txt Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch. 2010-12-27 23:58:16 +00:00
glossary.txt Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
index.txt Replaced http by https in djangoproject.com links 2012-03-13 17:53:31 +00:00
make.bat Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin. 2011-07-19 09:00:24 +00:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
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/