mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 13:44:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Kevin Christopher Henry 61867e226d [1.5.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:28 -04:00
..
_ext [1.5.x] Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:26:23 -04:00
_theme/djangodocs [1.5.x] Addeded CSS to bold deprecation notices. 2013-01-09 19:05:00 -05:00
faq [1.5.x] Fixed #15379 - Added "how to cite Django" to FAQ. 2013-03-29 16:50:33 -04:00
howto [1.5.x] Fixed #20900 -- Documented RemoteUserBackend.authenticate 2013-09-05 06:32:55 -04:00
internals [1.5.x] Documentation -- added instructions on working with pull requests 2013-09-13 08:27:28 -04:00
intro Fixed #19211 -- Adapted tutorial for Python 3 2013-09-05 08:53:24 +02: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 [1.5.X] Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:20:46 -05:00
ref [1.5.x] Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH. 2013-09-11 08:18:52 -04:00
releases [1.5.x] Added 1.4.7/1.5.3 release notes 2013-09-10 21:08:34 -04:00
topics [1.5.x] Fixed #20887 -- Added a warning to GzipMiddleware in light of BREACH. 2013-09-11 08:18:52 -04:00
conf.py [1.5.x] Bump version numbers for 1.5.3 security release. 2013-09-10 20:25:27 -05: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 [1.5.x] Fixed #19897 - Updated static files howto. 2013-03-30 07:12:37 -04:00
make.bat [1.5.x] Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:50:00 -05:00
Makefile [1.5.x] Allowed overriding variables in docs/Makefile. 2013-07-29 06:52:50 -04:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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/