mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-20 08:24:58 +00:00
Code Issues 24 Releases Wiki Activity
fb7c347f7b
django/docs
History
Tim Graham fb7c347f7b Fixed #1349 -- Clarified docs on serving files from STATIC/MEDIA_URL.
2014-05-05 07:36:53 -04:00
..
_ext
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Fixed #1349 -- Clarified docs on serving files from STATIC/MEDIA_URL. 2014-05-05 07:36:53 -04:00
internals Fixed #3214 -- Stopped parsing SQL with regex. 2014-04-26 17:46:23 +02:00
intro Fixed #22558 -- Added missing word in contributing docs 2014-05-02 08:28:07 +02:00
man Fixed clash caused by the newly introduced -e shorthand for makemessages --exclude. 2014-05-02 23:07:17 +07:00
misc
ref Fixed #1349 -- Clarified docs on serving files from STATIC/MEDIA_URL. 2014-05-05 07:36:53 -04:00
releases Fixed #22429 -- Incorrect SQL when using ~Q and F 2014-05-05 13:02:11 +03:00
topics Fixed #22575 -- Fixed typo in docs/topics/class-based-views/generic-editing.txt. 2014-05-05 06:41:01 -04:00
conf.py Updated doc links to point to Python 3 documentation 2014-04-26 16:02:53 +02: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 Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03: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/