mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00
Code Issues 24 Releases Wiki Activity
6295ea0027
django/docs
History
Tim Graham 3569536491 Fixed #23314 -- Tempered recommendation of storing profile data on custom user. 
Thanks gavinwahl for the report.
2014-08-19 07:24:36 -04:00
..
_ext Fixed #23067 -- Updated docs to use django-admin 2014-07-30 14:14:03 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Fixed #23016 -- Updated FAQs per Aymeric's suggestions. 2014-08-12 13:46:10 -04:00
howto Fixed #14638 -- Clarified model Field.to_python() docs. 2014-08-18 12:53:25 -04:00
internals Fixed #23269 -- Deprecated django.utils.remove_tags() and removetags filter. 2014-08-15 08:20:02 -04:00
intro Fixed #23303 -- Added BEGIN and COMMIT statements to the output of sqlmigrate. 2014-08-18 18:55:12 +02:00
man Replaced django-admin.py with django-admin in the man page. 2014-07-31 23:46:49 +02:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #17272 -- Documented that non-editable fields are skipped during model validation. 2014-08-19 07:18:05 -04:00
releases Fixed #18355 -- Added ordering options to list based generic views. 2014-08-15 11:09:47 -04:00
topics Fixed #23314 -- Tempered recommendation of storing profile data on custom user. 2014-08-19 07:24:36 -04:00
conf.py Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode. 2014-06-07 08:54:54 -04:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Introduced a technical board. 2014-08-01 14:41:24 +02:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Added some words to spelling_wordlist. 2014-08-14 14:13:08 -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/