1
0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
django/docs
2017-05-04 00:02:14 -04:00
..
_ext
_theme
faq Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
howto Refs #27795 -- Replaced many force_text() with str() 2017-04-27 09:10:02 +02:00
internals Fixed broken link to QUnit docs. 2017-05-03 07:31:59 -04:00
intro Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
man
misc
ref Fixed broken link to mysqlclient docs. 2017-05-02 20:17:14 -04:00
releases Fixed #28161 -- Fixed return type of ArrayField(CITextField()). 2017-05-04 00:02:14 -04:00
topics Fixed #28139 -- Added another level of headings in the topics index. 2017-05-01 08:53:54 -04:00
conf.py
contents.txt
glossary.txt
index.txt Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:36:44 -04:00
make.bat
Makefile
README
spelling_wordlist Fixed #27644 -- Doc'd FileSystemStorage.get_created_time(). 2017-04-26 13:33:35 -04: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/