mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
Code Issues Releases Wiki Activity
030dd4f72c
django/docs
History
Ben Davis 030dd4f72c Fixed #22220 -- Added more examples to reverse() documention. 
Thanks EvilDMP for the suggestions.
2014-04-16 20:29:17 -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 Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Added RemoteUserMiddleware to middleware reference page. 2014-04-16 07:22:15 -04:00
internals Fixed #22457 -- Fixed contributing guide w/o github set-up 2014-04-16 09:33:53 -04:00
intro Fixed #22453 -- Corrected DoesNotExist message in docs. 2014-04-16 08:36:02 -04: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 #22220 -- Added more examples to reverse() documention. 2014-04-16 20:29:17 -04:00
releases Fixed #22369 -- Added count parameter to assertTemplateUsed 2014-04-14 15:55:10 -04:00
topics Fixed #22455 -- Documented return values for send_mail and send_mass_mail 2014-04-16 17:35:17 -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 Whitespace cleanup. 2013-10-10 16:49:20 -04:00
spelling_wordlist Fixed spelling errors in documentation. 2014-04-16 09:39:00 -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/