mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
Code Issues 25 Releases Wiki Activity
05d36dc06e
django/docs
History
Baptiste Mispelon 05d36dc06e Always use parentheses when documenting a method with no arguments.
2014-01-22 22:26:10 +01:00
..
_ext Fixed E127 pep8 warnings. 2013-12-14 11:59:15 -05:00
_theme/djangodocs Fixed #21558 -- Support building CHM files. 2013-12-04 16:46:56 +01:00
faq Django sees more than 1mm hits per hour 2013-12-31 16:23:20 -08:00
howto Always use parentheses when documenting a method with no arguments. 2014-01-22 22:26:10 +01:00
internals Fixed #16905 -- Added extensible checks (nee validation) framework 2014-01-20 10:45:21 +08:00
intro Fixed #16905 -- Added extensible checks (nee validation) framework 2014-01-20 10:45:21 +08: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 Always use parentheses when documenting a method with no arguments. 2014-01-22 22:26:10 +01:00
releases Added a link to the 1.6 release notes which also fixed a rendering issue. 2014-01-22 11:04:44 -05:00
topics Always use parentheses when documenting a method with no arguments. 2014-01-22 22:26:10 +01:00
conf.py Pointed intersphinx links to Python's default version. 2013-12-30 19:09:45 +01:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Fixed #16905 -- Added extensible checks (nee validation) framework 2014-01-20 10:45:21 +08:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
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/