1
0
mirror of https://github.com/django/django.git synced 2025-01-13 11:57:01 +00:00
django/docs
2016-05-06 08:26:07 -04:00
..
_ext
_theme
faq
howto Fixed code example in docs/howto/custom-lookups.txt 2016-05-06 08:26:07 -04:00
internals
intro
man
misc
ref Fixed -- Obsoleted Field.get_prep_lookup()/get_db_prep_lookup() 2016-05-04 20:02:01 +02:00
releases Fixed -- Obsoleted Field.get_prep_lookup()/get_db_prep_lookup() 2016-05-04 20:02:01 +02:00
topics Normalized "an SQL" spelling. 2016-05-03 19:30:48 -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/