0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
2017-01-02 08:40:44 -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 Fixed #27641 -- Doc'd default local-memory caching in deployment checklist. 2016-12-28 19:43:01 -05:00
internals Refs #24154 -- Added check_aggregate_support() to deprecation timeline. 2016-12-31 14:02:44 -05:00
intro Fixed #25415 -- Made DiscoverRunner run system checks. 2016-12-29 12:33:24 -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 Removed links to deprecated GeoIP. 2016-12-30 19:13:49 -05:00
releases Refs #27637 -- Fixed timesince, timeuntil on New Year's Eve in a leap year. 2017-01-02 08:40:44 -05:00
topics Removed nonexistent LogoutView context from docs. 2016-12-31 07:57:39 -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

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/