mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Code Issues 25 Releases Wiki Activity
a772ea8117
django/docs
History
Aymeric Augustin 5abc43cabf Updated examples in the docs after eade315d.
2013-09-17 10:05:45 +02:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs Fixed #18789 - Fixed some text wrap issues with methods in the docs. 2013-02-19 10:25:26 -05:00
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Cleaned up 1.5.4/1.4.8 release notes 2013-09-15 14:14:26 -04:00
internals Fixed #17627 -- Renamed util.py files to utils.py 2013-09-16 12:52:05 -04:00
intro Updated examples in the docs after eade315d. 2013-09-17 10:05:45 +02:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Fixed #17627 -- Renamed util.py files to utils.py 2013-09-16 12:52:05 -04:00
releases Fixed #17627 -- Renamed util.py files to utils.py 2013-09-16 12:52:05 -04:00
topics Reworded a paragraph in the logging docs. 2013-09-16 17:49:46 -03:00
conf.py Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt Consolidated documentation for F() and Q() 2013-09-06 12:57:25 -05: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

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/