1
0
mirror of https://github.com/django/django.git synced 2024-12-28 12:06:22 +00:00
django/docs
Ian Lee 04c262aea9 [1.8.x] Broke long lines in code examples.
The website only renders code blocks at 96 chars, and therefore
long code lines get wrapped. Manually breaking the lines prevents
the wrapping from occurring.

Backport of 00fbd8fd52 from master
2015-02-23 07:46:00 -05:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -05:00
_theme
faq Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
howto [1.8.x] Broke long lines in code examples. 2015-02-23 07:46:00 -05:00
internals [1.8.x] Fixed #24351, #24346 -- Changed the signature of allow_migrate(). 2015-02-20 21:55:50 +07:00
intro [1.8.x] Updated tutorial to use explicit relative imports. 2015-02-22 14:20:25 -05:00
man [1.8.x] Removed gather_profile_stats.py 2015-02-06 08:55:02 -05:00
misc
ref [1.8.x] Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:36:51 -05:00
releases [1.8.x] Added formats for the Azerbaijani locale. 2015-02-23 07:37:42 -05:00
topics [1.8.x] Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:36:51 -05:00
conf.py [1.8.x] Fixed E265 comment style 2015-02-06 09:35:08 -05:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -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 [1.8.x] Added formats for the Azerbaijani locale. 2015-02-23 07:37:42 -05: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/