0
0
mirror of https://github.com/django/django.git synced 2024-11-25 16:09:27 +01:00
django/docs
2018-09-10 13:00:34 -04:00
..
_ext Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq
howto Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
internals Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
intro Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
man
misc
ref Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
releases Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
topics Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
conf.py
contents.txt
glossary.txt
index.txt
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/