mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 18:16:19 +00:00
Code Issues 25 Releases Wiki Activity
60d2213d43
django/docs
History
Aymeric Augustin 60d2213d43 [1.7.x] Small doc changes missed in 66076268. 
Partial backport of 253e8ac2 from master.
2014-03-21 22:09:57 +01:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq
howto Fixed #21179 -- Added a StreamingHttpResponse example for CSV files. 2014-03-17 07:22:27 -04:00
internals [1.7.x] Small doc changes missed in 66076268. 2014-03-21 22:09:57 +01:00
intro Substituted 'shortcut function' for 'factory method' in tutorial 2014-03-09 14:07:39 -07:00
man
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref [1.7.x] Small doc changes missed in 66076268. 2014-03-21 22:09:57 +01:00
releases [1.7.x] Fixed typos in docs (django.contrib.site) 2014-03-21 20:02:03 +01:00
topics Amended login required mixin documentation to honor **initkwargs. 2014-03-17 18:45:06 -04:00
conf.py Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Updated spelling_wordlist. 2014-03-11 08:11:16 -04: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-doc.org/