mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
Code Issues 25 Releases Wiki Activity
a44cbca2a5
django/docs
History
Jacob Kaplan-Moss a44cbca2a5 Added a note about LTS releases.
2013-09-07 12:47:48 -05:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs
faq
howto Fixed #20938 -- Added cached sessions note to deployment checklist. 2013-09-07 12:58:49 -04:00
internals Added a note about LTS releases. 2013-09-07 12:47:48 -05:00
intro Fixed #20876 -- Changed Poll model name in tutorial to Question 2013-09-07 13:37:09 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc
ref Merge pull request #1592 from pablomouzo/fix-admin-view-response-methods-docs 2013-09-07 09:38:48 -07:00
releases Fixed some sphinx errors and added some links. 2013-09-06 16:15:35 -04:00
topics Fixed a link in topics/testing/overview.txt 2013-09-06 17:41:12 -04:00
conf.py
contents.txt
glossary.txt
index.txt Consolidated documentation for F() and Q() 2013-09-06 12:57:25 -05:00
make.bat
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/