mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-25 10:35:48 +00:00
Code Issues 25 Releases Wiki Activity
197863523a
django/docs
History
Julien Phalip 197863523a Restructured the documentation's index page and added some introductory sentences to each section.
2012-08-04 16:42:33 -07:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs
faq Fixed #18601 -- Specified that Python minimum version is 2.6.5 2012-07-13 17:33:13 +02:00
howto Fixed #18626 -- rst syntax collision. 2012-07-15 11:25:13 +02:00
internals Reinstated Pinax link that was still in use by others. 2012-08-02 20:27:53 +10:00
intro Fixed #17704 - Updated the StackedInline section in Tutorial 2; thanks xbito for the draft patch. 2012-08-02 19:22:49 -04:00
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 Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete
ref Small improvement to the contrib.messages doc introduction. 2012-08-04 15:46:15 -07:00
releases Fixed #5524 -- Do not remove cleaned_data when a form fails validation 2012-08-04 14:22:23 +02:00
topics Merge pull request #153 from webjunkie/patch-1 2012-08-04 12:50:42 -07:00
conf.py [py3] Documented coding guidelines for Python 3. 2012-07-22 10:29:07 +02:00
contents.txt
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Restructured the documentation's index page and added some introductory sentences to each section. 2012-08-04 16:42:33 -07:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +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/