mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-19 07:54:07 +00:00
Code Issues 24 Releases Wiki Activity
1aa218b857
django/docs
History
Julien Phalip 0133d66734 Removed a colloquialism ("and then some") from the documentation index page that would be confusing to non-native English speakers.
2012-09-10 17:27:50 -07:00
..
_ext
_theme/djangodocs
faq Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
howto Fixed #15566 - Documented that update() doesn't honor DateField.auto_now 2012-09-08 06:38:41 -04:00
internals Fixed #18054 -- Deprecated contrib.markup. Thanks to simukis for the initial patch. 2012-09-08 12:13:46 -04:00
intro Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
man
misc Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
ref Document and test 'type' usage in Widget attrs 2012-09-10 19:31:11 +02:00
releases Replaced backwards-incompatible changes reference 2012-09-09 12:53:32 -04:00
topics Replaced backwards-incompatible changes reference 2012-09-09 12:53:32 -04:00
conf.py Added latex preamble for ≤. 2012-08-28 22:45:51 +02: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 Removed a colloquialism ("and then some") from the documentation index page that would be confusing to non-native English speakers. 2012-09-10 17:27:50 -07:00
make.bat
Makefile
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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.pocoo.org/