1
0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
django/docs
2015-01-11 00:30:47 +01:00
..
_ext Fixed #23968 -- Replaced list comprehension with generators and dict comprehension 2014-12-08 07:58:23 -05:00
_theme
faq Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
howto Updated custom template tags how-to. 2015-01-10 20:17:22 +01:00
internals Added Josh Smeaton bio to team 2015-01-10 13:48:37 +11:00
intro Wrote main documentation for templates. 2015-01-10 20:16:19 +01:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc
ref Improved template ugrading docs. 2015-01-10 21:11:58 +01:00
releases Refs #24110 -- Added a more descriptive release note and fixed a spelling mistake. 2015-01-11 00:30:47 +01:00
topics Wrote main documentation for templates. 2015-01-10 20:16:19 +01:00
conf.py Fixed #24001 -- Added range fields for PostgreSQL. 2015-01-10 16:18:19 +00:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Moved doc on the DTL's syntax to the ref/ section. 2015-01-10 19:41:14 +01:00
make.bat
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
spelling_wordlist Fixed #24001 -- Added range fields for PostgreSQL. 2015-01-10 16:18:19 +00: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/