mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
Code Issues 25 Releases Wiki Activity
91c26eadc9
django/docs
History
Russell Keith-Magee 91c26eadc9 Refs #14881 -- Document that User models need to have an integer primary key. 
Thanks to Kaloian Minkov for the reminder about this undocumented requirement.
2013-02-16 10:21:05 +08:00
..
_ext Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives 2013-02-09 09:16:10 -05:00
_theme/djangodocs Addeded CSS to bold deprecation notices. 2013-01-09 19:03:34 -05:00
faq Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
howto Fixed #19749 -- Documented ending param to command's self.stdout/err 2013-02-09 10:17:26 +01:00
internals Fixed #19689 -- Renamed Model._meta.module_name to model_name. 2013-02-05 04:16:07 -05:00
intro Updated tutorial 1 to reflect changes in default project template. 2013-02-10 18:07:50 -05:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc Fixed typos in docs and comments 2013-01-29 10:55:55 -07:00
ref Fixed #18558 -- Added url property to HttpResponseRedirect* 2013-02-13 10:29:32 +01:00
releases Fixed #18558 -- Added url property to HttpResponseRedirect* 2013-02-13 10:29:32 +01:00
topics Refs #14881 -- Document that User models need to have an integer primary key. 2013-02-16 10:21:05 +08:00
conf.py Fixed #19699 - Removed "Please see the release notes" from versionadded/changed directives 2013-02-09 09:16:10 -05:00
contents.txt
glossary.txt
index.txt Added more shortcuts to i18n docs in index page. 2013-01-25 13:50:37 -03:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05: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/