mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
Code Issues 25 Releases Wiki Activity
85757d0e79
django/docs
History
Ross Brunton 6b28e957df Fixed #24379 -- Documented that remote user example disables ModelBackend.
2015-03-02 19:53:11 -05:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Removed compatibility with Python 3.2. 2015-01-17 09:00:17 -05:00
howto Fixed #24379 -- Documented that remote user example disables ModelBackend. 2015-03-02 19:53:11 -05:00
internals Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
intro Improved wording in tutorial 1. 2015-02-27 17:53:11 -05:00
man Removed gather_profile_stats.py 2015-02-06 07:58:31 -05:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #24439 -- Removed incorrect make_object_list attributes in CBV docs. 2015-03-02 13:33:11 -05:00
releases Added stub release notes for 1.7.6. 2015-02-25 09:11:19 -05:00
topics Fixed #13015 -- Clarified language about model instances attached to forms. 2015-03-02 18:44:23 -05:00
conf.py Fixed E265 comment style 2015-02-06 09:30:35 -05:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Added a "Writing migrations" how-to. 2015-02-03 13:09:54 -05:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Reverted "Fixed #24325 -- Documented change in ModelForm.save() foreign key access." 2015-02-24 11:50:21 -05: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 ``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/