p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
Helen Sherwood-Taylor 4ccdf6e57f Fixed #24041 -- Documented effect of changing a model instance's primary key. 2014-12-24 15:06:09 -05:00
..
_ext Fixed #23968 -- Replaced list comprehension with generators and dict comprehension 2014-12-08 07:58:23 -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 Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
howto Updated some other external links in the docs 2014-12-19 18:07:52 +01:00
internals Fixed #21414 -- Removed RelatedObject and deprecated Field.related. 2014-12-23 10:54:25 -05:00
intro Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #24041 -- Documented effect of changing a model instance's primary key. 2014-12-24 15:06:09 -05:00
releases Fixed #10414 -- Made select_related() fail on invalid field names. 2014-12-24 14:54:30 -05:00
topics Fixed #24041 -- Documented effect of changing a model instance's primary key. 2014-12-24 15:06:09 -05:00
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
conf.py Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Updated formtools docs to point at new package outside the Django repo. 2014-11-26 09:41:52 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Fixed some docs spelling mistakes. 2014-12-23 14:41:53 -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/