0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
2016-02-06 21:10:36 +02:00
..
_ext Fixed #23868 -- Added support for non-unique django-admin-options in docs. 2016-01-14 18:21:33 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -05:00
howto Fixed #25833 -- Added support for non-atomic migrations. 2016-02-05 09:09:05 -05:00
internals Idan -> core alumni 2016-01-28 11:25:56 +02:00
intro Fixed #26169 -- Fixed tutorial reference in reusable apps tutorial. 2016-02-04 07:39:12 -05:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Fixed spelling -- super set -> superset. 2016-02-06 09:58:50 +05:00
releases Fixed title formatting in backwards-incompat section of 1.10 release notes 2016-02-06 21:10:36 +02:00
topics Fixed #12405 -- Added LOGOUT_REDIRECT_URL setting. 2016-02-04 10:35:37 -05:00
conf.py Fixed #23868 -- Added support for non-unique django-admin-options in docs. 2016-01-14 18:21:33 -05:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
make.bat
Makefile
README
spelling_wordlist Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -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/