mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 23:44:22 +00:00
Code Issues 24 Releases Wiki Activity
7055e20d24
django/docs
History
Simon Meers ee1b3e2a3a Fixed minor typo in 1.3 release notes.
2012-09-06 21:00:16 +10:00
..
_ext
_theme/djangodocs
faq Fixed #18905 - Changed to new url for Djangopeople 2012-09-05 16:20:23 +05:30
howto
internals Fixed #18647 - Removed link to Malcolm's blog which is gone. 2012-08-30 07:44:41 -04:00
intro
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #18904 - Typo in MySQL link; thanks Johie Anderson for the report. 2012-09-05 17:50:17 -04:00
releases Fixed minor typo in 1.3 release notes. 2012-09-06 21:00:16 +10:00
topics Changes day to from 2 to 30 2012-09-03 16:31:37 +01:00
conf.py Added latex preamble for ≤. 2012-08-28 22:45:51 +02: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 Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Fixed #17378 - Added a flattened index for class-based views. 2012-09-01 09:20:38 -04:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
Makefile
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/