1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2018-02-01 09:05:14 -05:00
..
_ext Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
_theme Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
faq
howto Renamed the "Supported versions" label. 2018-01-31 10:17:06 -05:00
internals Made minor edits and corrections to docs/internals/git.txt. 2018-01-31 13:04:19 -05:00
intro Renamed the "Supported versions" label. 2018-01-31 10:17:06 -05:00
man
misc
ref Disambiguated "settings" in SpatiaLite note. 2018-01-31 12:20:24 -05:00
releases Fixed CVE-2018-6188 -- Fixed information leakage in AuthenticationForm. 2018-02-01 09:05:14 -05:00
topics Fixed #28403 -- Added missing formats in FORMAT_MODULE_PATH docs. 2018-01-24 13:38:15 -05:00
conf.py Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05: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
Makefile
README
spelling_wordlist Fixed "template tag" spelling in docs. 2018-01-23 09:40:18 -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/