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
43cfc652d2
django/docs
History
Tim Graham 43cfc652d2 Fixed doc typo in previous commit.
2013-10-24 21:25:51 -04:00
..
_ext Fixed E221 pep8 warnings. 2013-10-22 09:51:39 -04:00
_theme/djangodocs Fixed #20910 -- Added a "snippet" sphinx directive to allow prefixing a filename. 2013-10-14 13:00:57 -04:00
faq Fixed #8918 -- Made FileField.upload_to optional. 2013-10-11 08:07:25 -04:00
howto Fixed #20962 -- Documented that template tag render() may raise exceptions. 2013-10-14 11:53:15 -04:00
internals Fixed #19941 -- Removed sys.path hack when running the test suite. 2013-10-23 18:27:06 -04:00
intro Fixed indentation of example in tutuorial 2. 2013-10-22 08:10:56 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Fixed #21219 -- Added a way to set different permission for static files. 2013-10-24 17:40:01 -04:00
releases Fixed #21271 -- Added timeout parameter to SMTP EmailBackend. 2013-10-24 20:38:00 -04:00
topics Fixed doc typo in previous commit. 2013-10-24 21:25:51 -04:00
conf.py Fixed E225 pep8 warnings. 2013-10-23 06:09:29 -04:00
contents.txt
glossary.txt
index.txt Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
make.bat
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Whitespace cleanup. 2013-10-10 16:49:20 -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/