1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2018-12-04 16:21:38 +01: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 Refs #28814 -- Doc'd Python 3.7 compatibility in Django 1.11.x. 2018-11-17 15:40:35 -05:00
howto Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
internals Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
intro Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
man
misc
ref Refs #28205 -- Corrected ModelAdmin.prepopulated_fields docs regarding when they're populated. 2018-11-28 14:48:03 -05:00
releases Added stub release notes for 2.1.5 release. 2018-12-04 16:21:38 +01:00
topics Fixed #29991 -- Doc'd logger propogation for the default logging config. 2018-11-29 16:59:43 -05:00
conf.py Removed obsolete html_use_smartypants Sphinx option. 2018-09-18 11:51:04 -04:00
contents.txt
glossary.txt
index.txt Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
make.bat
Makefile
README
spelling_wordlist

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/