1
0
mirror of https://github.com/django/django.git synced 2025-01-12 11:26:23 +00:00
django/docs
Timothy Allen 5fe9b7b40a Fixed -- Updated the design of the 'Congrats' page for new Django projects.
Developed by Timothy Allen and Chad Whitman of The Wharton School with
shepherding from Aymeric Augustin and Collin Anderson.
2017-08-07 10:33:55 -04:00
..
_ext Refs -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
_theme Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:30 -04:00
faq Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
howto Replaced "not A== B" with "A != B" in docs/howto/writing-migrations.txt. 2017-07-26 09:34:10 -04:00
internals Fixed -- Deprecated the context arg of Field.from_db_value() and Expression.convert_value(). 2017-07-20 16:30:08 -04:00
intro Fixed -- Updated the design of the 'Congrats' page for new Django projects. 2017-08-07 10:33:55 -04:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Fixed -- Clarified what characters ASCII/UnicodeUsernameValidator accept. 2017-07-27 08:42:01 -04:00
releases Fixed -- Fixed GEOS version parsing with a commit hash at the end. 2017-08-02 09:30:30 -04:00
topics Fixed -- Allowed naming the migration generated by squashmigrations. 2017-07-26 13:47:35 -04:00
conf.py Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
contents.txt Fixed -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Refs -- Fixed broken link to #django IRC logs. 2017-07-21 18:09:48 -04:00
make.bat Fixed - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Fixed -- Fixed ClearableFileInput rendering as a subwidget of MultiWidget. 2017-07-19 14:28:06 -04:00

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/