mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-25 07:59:34 +01:00
Code Issues Releases Wiki Activity
7b42036752
django/docs
History
Zan Anderle 7b42036752 Fixed #5405 -- Added admindocs support for reStructured text in model docstrings 
Thanks elvard and gkmngrgn for work on the patch and Markus H. for review.
2014-11-03 15:30:46 -05:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme
faq Fixed #23527 -- Removed Cheetah references in docs 2014-09-21 18:03:31 +02:00
howto Clarified custom lookups output_field documentation 2014-11-03 15:52:27 +02:00
internals Fixed #23656 -- Made FormMixin.get_form's form_class argument optional. 2014-10-30 19:10:52 -04:00
intro Replaced dead links to python-distribute.org. 2014-10-24 18:58:31 -04:00
man
misc
ref Fixed spelling mistake in docs/ref/request-response.txt 2014-11-03 14:18:46 -05:00
releases Fixed #5405 -- Added admindocs support for reStructured text in model docstrings 2014-11-03 15:30:46 -05:00
topics Fixed #21281 -- Made override_settings act at class level when used as a TestCase decorator. 2014-11-03 14:14:39 -05:00
conf.py Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Moved CSRF docs out of contrib. 2014-11-03 07:47:39 -05:00
make.bat
Makefile
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Fixed spelling errors in docs. 2014-10-28 10:15:52 -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 ``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/