1
0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
django/docs
Adam Allred 4e78e389b1 Fixed #29774 -- Fixed django-admin shell hang on startup.
sys.stdin.read() blocks waiting for EOF in shell.py which will
likely never come if the user provides input on stdin via the
keyboard before the shell starts. Added check for a tty to
skip reading stdin if it's not present.

This still allows piping of code into the shell (which should
have no TTY and should have an EOF) but also doesn't cause it
to hang if multi-line input is provided.
2018-10-19 20:00:12 -04:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq Fixed #29261 -- Doc'd the reason for LICENSE.python. 2018-06-29 20:00:58 -04:00
howto Simplified deployment checklist docs on customizing error views. 2018-10-11 09:50:08 -04:00
internals Fixed #29817 -- Deprecated settings.FILE_CHARSET. 2018-10-15 17:15:41 -04:00
intro Added a paragraph in docs/intro/contributing.txt. 2018-10-16 16:10:44 -04:00
man Updated man page for Django 2.1 alpha. 2018-05-17 09:30:20 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Fixed #29858 -- Clarified docs regarding CSRF token header name. 2018-10-18 19:44:15 -04:00
releases Fixed #29774 -- Fixed django-admin shell hang on startup. 2018-10-19 20:00:12 -04:00
topics Updated Jinja2 static tag example to use django.templatetags. 2018-10-18 19:19:56 -04:00
conf.py Removed obsolete html_use_smartypants Sphinx option. 2018-09-18 11:51:04 -04:00
contents.txt
glossary.txt
index.txt Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README
spelling_wordlist Fixed #28990 -- Added autosummarize parameter to BrinIndex. 2018-08-02 11:26:58 -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/