mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
Code Issues 25 Releases Wiki Activity
12a2a23100
django/docs
History
Adrian Holovaty 12a2a23100 Reworded part of 'Running only some of the tests' in docs/internals/contributing.txt 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15799 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-03-14 05:34:28 +00:00
..
_ext Reformated some code for readability. 2010-11-20 21:00:41 +00:00
_theme/djangodocs
faq Fixed #15541 -- Updated FAQ to point at djangosites.org instead of defunct wiki page. Thanks to aaugustin for the report and draft patch. 2011-03-03 18:26:15 +00:00
howto Converted the new contributions docs to unix line endings. 2011-02-27 23:31:46 +00:00
internals Reworded part of 'Running only some of the tests' in docs/internals/contributing.txt 2011-03-14 05:34:28 +00:00
intro Fixed #15257 - Add a link about field lookups to the tutorial; thanks dwillis. 2011-02-22 00:57:28 +00:00
man Fixed #7735 -- Added support for IPv6 adresses to runserver and testserver management command. Thanks to Jason Alonso and Łukasz Rekucki for the report and initial patches. 2010-11-26 13:33:53 +00:00
misc
obsolete
ref Fixed #15592 -- corrected an missing backtick in the syndication docs. Thanks to bradley.ayers for the report and patch. 2011-03-10 17:21:16 +00:00
releases Tweaked r15769 to remove reference to "project." 2011-03-07 17:00:57 +00:00
topics Fixed #15558 -- Improved QuerySet reference docs and cleaned up numerous reST/sphinx problems. 2011-03-08 19:51:19 +00:00
conf.py Fixed #15196 -- Bumped version up a bit in Sphinx configuration. Thanks, Eric Holscher. 2011-01-30 20:31:39 +00: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
index.txt Fixed #6181 - Document django.views.decorators.http - thanks adamv for the patch. 2010-12-27 13:27:26 +00:00
Makefile
README Added a README for building offline HTML docs. 2010-11-06 17:44:26 +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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` 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/