mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
Code Issues 25 Releases Wiki Activity
60d2dde286
django/docs
History
Tim Graham 60d2dde286 Fixed #22247 -- Replaced "upstream" with "downstream" in cache docs. 
Thanks valgarv at gmx.net for the report.
2014-03-24 09:19:27 -04: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 Removed PIL compatability layer per deprecation timeline. 2014-03-21 10:54:53 -04:00
howto Fixed #21179 -- Added a StreamingHttpResponse example for CSV files. 2014-03-17 07:22:27 -04:00
internals Removed django.middleware.doc. Refs #20126. 2014-03-21 22:07:39 +01:00
intro Substituted 'shortcut function' for 'factory method' in tutorial 2014-03-09 14:07:39 -07:00
man Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #17922 -- Added required_css_class to form label. 2014-03-24 08:11:54 -04:00
releases Fixed #21665 -- Documented that changes in assertRedirects may be required given new URL escaping behavior. 2014-03-24 09:08:47 -04:00
topics Fixed #22247 -- Replaced "upstream" with "downstream" in cache docs. 2014-03-24 09:19:27 -04:00
conf.py Bumped version to reflect master is now pre-1.8. 2014-03-21 06:17:14 -04: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/