django/docs
Michiel Beijen 5e8625ba64 Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
..
_ext Refs #23919 -- Replaced super(ClassName, self) with super() in docs. 2017-01-25 11:53:05 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
howto Fixed #28031 -- Removed notes about old uWSGI/sentry versions (refs #20537). 2017-04-06 09:09:49 -04:00
internals Removed inappropriate highlighting in committing-code.txt. 2017-04-20 11:32:56 -04:00
intro Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
releases Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
topics Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
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
conf.py Refs #23919 -- Removed Python 2 notes in docs. 2017-01-18 11:51:29 -05:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:36:44 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Added "reraising" to docs/spelling_wordlist 2017-04-20 13:03:24 -04: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 ``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/