0
0
mirror of https://github.com/django/django.git synced 2024-11-30 07:06:18 +01:00
django/docs
2016-11-16 17:40:37 -05:00
..
_ext Fixed #27463 -- Fixed E741 flake8 warnings. 2016-11-14 17:40:28 -05:00
_theme
faq Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:00:50 -05:00
howto Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:00:50 -05:00
internals Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:00:50 -05:00
intro Updated "fork Django on GitHub" link. 2016-11-04 05:47:49 +01:00
man
misc
ref Fixed #27488 -- Added SpatiaLite suppport for IsValid, MakeValid, and __isvalid. 2016-11-16 09:43:54 -05:00
releases Fixed #27488 -- Added SpatiaLite suppport for IsValid, MakeValid, and __isvalid. 2016-11-16 09:43:54 -05:00
topics Fixed #27467 -- Made UserAttributeSimilarityValidator max_similarity=0/1 work as documented. 2016-11-16 17:40:37 -05:00
conf.py Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:00:50 -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/