1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
2016-04-16 19:51:00 +02:00
..
_ext
_theme
faq Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -05:00
howto Updated Windows docs for completeness 2016-04-16 13:06:37 +02:00
internals Fixed #19567 -- Added JavaScriptCatalog and JSONCatalog class-based views 2016-04-15 17:28:54 +02:00
intro Fixed #26485 -- Fixed typo in docs/intro/tutorial07. 2016-04-10 14:19:54 -04:00
man
misc
ref Updated indentation in GEOS docs 2016-04-16 19:51:00 +02:00
releases Fixed #19567 -- Added JavaScriptCatalog and JSONCatalog class-based views 2016-04-15 17:28:54 +02:00
topics Fixed #19567 -- Added JavaScriptCatalog and JSONCatalog class-based views 2016-04-15 17:28:54 +02:00
conf.py Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:30:32 -05:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist Added 'prefetches to docs/spelling_wordlist. 2016-02-26 16:06:34 -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/