django/docs
Hasan Ramezani 7d3fe36c62 Alphabetized imports in docs/ref/contrib/postgres/fields.txt. 2018-05-07 07:46:29 -04:00
..
_ext Bumped minimum Sphinx version to 1.6.0. 2018-03-22 20:30:03 -04:00
_theme Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
faq
howto Fixed #29360 -- Removed Fabric examples in docs. 2018-04-29 22:12:40 -04:00
internals Fixed #29369 -- Mentioned the #django-dev IRC channel in contributing index. 2018-04-28 20:33:53 -04:00
intro Clarified wording in tutorial text. 2018-04-19 11:09:38 +02:00
man
misc
ref Alphabetized imports in docs/ref/contrib/postgres/fields.txt. 2018-05-07 07:46:29 -04:00
releases Added stub release notes for 2.0.6. 2018-05-01 22:01:48 -04:00
topics Fixed #26688 -- Fixed HTTP request logging inconsistencies. 2018-05-04 20:55:03 -04:00
Makefile
README
conf.py Updated intersphinx_mapping URL for sphinx. 2018-04-04 11:32:14 -04:00
contents.txt
glossary.txt
index.txt Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat
spelling_wordlist Fixed #29360 -- Removed Fabric examples in docs. 2018-04-29 22:12:40 -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/