mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 24 Releases Wiki Activity
django/docs
History
François Freitag 0783aa7deb Refs #23811 -- Corrected git bisect run example usage. 2016-11-21 06:55:03 -05:00
..
_ext Fixed #27463 -- Fixed E741 flake8 warnings. 2016-11-14 17:40:28 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
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 Refs #23811 -- Corrected git bisect run example usage. 2016-11-21 06:55:03 -05:00
intro Updated "fork Django on GitHub" link. 2016-11-04 05:47:49 +01: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 Fixed #27482 -- Doc'd an example of Case() in QuerySet.filter(). 2016-11-17 12:39:35 -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
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04: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 Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:00:50 -05:00

README 

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/