0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
Aymeric Augustin e81e319f15 Fixed #20025 -- Pointed to a MySQLdb fork for Python 3.
Made a few minor compatibility adjustments.
2013-05-08 13:05:09 +02:00
..
_ext Adapted uses of versionchanged/versionadded to the new form. 2013-04-20 17:18:35 +02:00
_theme/djangodocs Fixed #18789 - Fixed some text wrap issues with methods in the docs. 2013-02-19 10:25:26 -05:00
faq Fixed #15379 - Added "how to cite Django" to FAQ. 2013-03-29 16:48:07 -04:00
howto Fixed #20330 -- Normalized spelling of "web server". 2013-04-29 19:40:43 +02:00
internals Added myself to the committers list. 2013-05-03 00:46:51 -07:00
intro Fixed Sphinx error in tutorial 1. 2013-05-07 18:18:42 -06:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Fixed #20025 -- Pointed to a MySQLdb fork for Python 3. 2013-05-08 13:05:09 +02:00
releases Corrected "it's" to "its" when used possessively. 2013-04-29 17:21:37 +02:00
topics Python 2.5 is not relevant to master. 2013-05-07 17:05:37 -06:00
conf.py Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives 2013-02-09 09:16:10 -05: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 #19897 - Updated static files howto. 2013-03-29 19:15:19 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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/