mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-31 21:46:05 +00:00
Code Issues 30 Releases Wiki Activity
9e734875fe
django/docs
History
Tim Graham 9e734875fe Fixed #24994 -- Documented the expected type of settings.SECRET_KEY.
2016-12-28 07:36:37 -05:00
..
_ext Fixed missing versionadded/changed annotations on docs.djangoproject.com. 2016-12-14 14:31:29 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Removed the importance of "core developers" in triaging tickets, etc. 2016-12-21 20:18:13 -05:00
howto Normalized casing of "custom user model". 2016-11-23 15:14:28 -05:00
internals Fixed #15667 -- Added template-based widget rendering. 2016-12-27 17:50:10 -05:00
intro Updated doc links to virtualenv website. 2016-11-22 08:36:41 -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 #24994 -- Documented the expected type of settings.SECRET_KEY. 2016-12-28 07:36:37 -05:00
releases Fixed #15667 -- Added template-based widget rendering. 2016-12-27 17:50:10 -05:00
topics Used a nontemporal example in QuerySet.bulk_create() in docs. 2016-12-27 09:59:07 -05:00
conf.py Removed deprecated html_translator_class sphinx config option. 2016-12-05 14:47:44 -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 #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
Makefile
README
spelling_wordlist Fixed #15667 -- Added template-based widget rendering. 2016-12-27 17:50:10 -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/