1
0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
django/docs
2016-11-22 13:49:18 -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 Updated doc links to virtualenv website. 2016-11-22 08:36:41 -05:00
internals Updated doc links to virtualenv website. 2016-11-22 08:36:41 -05:00
intro Updated doc links to virtualenv website. 2016-11-22 08:36:41 -05:00
man
misc
ref Fixed #27295 -- Added a system check to prohibit model names that start or end with an underscore or contain double underscores. 2016-11-22 10:14:10 -05:00
releases Fixed #27488 -- Added SpatiaLite suppport for IsValid, MakeValid, and __isvalid. 2016-11-16 09:43:54 -05:00
topics Fixed #27221 -- Doc'd how to escape a percent symbol in ugettext(). 2016-11-22 13:49:18 -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/