mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-19 02:01:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
django/docs
History
Tim Graham e905d4984d [1.7.x] Updated advice on six.moves.range/xrange; refs #23812. 
Backport of bc88ec550a from master
2014-12-13 13:42:45 -05:00
..
_ext
_theme
faq
howto [1.7.x] Fixed typo in docs/howto/custom-lookups.txt. 2014-12-08 07:20:00 -05:00
internals [1.7.x] Fixed typo in docs/internals/release-process.txt. 2014-11-21 11:49:48 -05:00
intro [1.7.x] Fixed #23907 -- Added admin.site.register in tutorial 2 for consistency. 2014-11-24 15:59:43 -05:00
man
misc
ref [1.7.x] Fixed #23961 -- Clarified when makemigrations will create a directory. 2014-12-09 07:31:33 -05:00
releases [1.7.x] Fixed #23455 -- Accept either bytes or text for related_name, convert to text. 2014-12-12 13:13:57 -07:00
topics [1.7.x] Updated advice on six.moves.range/xrange; refs #23812. 2014-12-13 13:42:45 -05:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile [1.7.x] Added an "htmlview" target to open docs after building them. 2014-12-08 07:24:07 -05:00
README
spelling_wordlist [1.7.x] Appeased spell checker. 2014-12-11 14:44:27 -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 ``sudo 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/