innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity
django1/docs
History
Kevin Christopher Henry c91ffd5f23 [1.6.x] Documentation -- added instructions on working with pull requests 
Since non-core contributors are asked to review patches, instructions
on working with pull requests were added to the Working with Git and
GitHub page (based on the existing instructions in the core
committers page).

Backport of 990ce9aab9 from master
 		2013-09-13 08:27:23 -04:00
..
_ext [1.6.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:26:11 -04:00
_theme/djangodocs Fixed #18789 - Fixed some text wrap issues with methods in the docs. 2013-02-19 10:25:26 -05:00
faq [1.6.x] Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 14:09:02 -04:00
howto [1.6.x] Fixed broken sphinx reference to staticfiles. 2013-09-10 16:31:51 -04:00
internals [1.6.x] Documentation -- added instructions on working with pull requests 2013-09-13 08:27:23 -04:00
intro [1.6.x] Fixed #20891 -- Removed part of the tutorial that requires pytz 2013-08-15 15:31:57 -04: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 [1.6.x] Fixed #21095 -- Documented new requirement for dates lookups. 2013-09-13 10:20:13 +02:00
releases [1.6.x] Fixed #21095 -- Documented new requirement for dates lookups. 2013-09-13 10:20:13 +02:00
topics [1.6.x] Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH. 2013-09-11 08:18:48 -04:00
Makefile [1.6.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:42 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Allow build of translated documentation 2013-06-08 16:13:51 +02:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Updated test failure example. 2013-05-12 17:29:34 -03:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00

README 

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/