django

mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00

History

ovalseven8 22bcd3a1d8 Fixed #29192 -- Corrected docs regarding overriding fields from abstract base classes.		2018-03-13 12:45:01 -04:00
..
_ext	Used console directive in "Writing documentation".	2018-03-07 16:19:22 -05:00
_theme	Fixed #28343 -- Add an OS chooser for docs command line examples.	2018-01-20 12:38:48 -05:00
faq
howto	Fixed #29165 -- Clarified how to load initial data with migrations.	2018-03-08 10:58:19 -05:00
internals	Added "Denial-of-service attacks" to the security issue severity classification.	2018-03-12 11:00:47 -04:00
intro	Removed "Remove any old versions of Django" install instructions.	2018-02-26 08:58:56 -05:00
man
misc
ref	Fixed a couple mistakes in docs/ref/forms/widgets.txt.	2018-03-12 09:39:09 -04:00
releases	Fixed #29213 -- Fixed autocomplete widget's translations for zh-hans/zh-hant.	2018-03-13 10:58:34 -04:00
topics	Fixed #29192 -- Corrected docs regarding overriding fields from abstract base classes.	2018-03-13 12:45:01 -04: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 #28960 -- Added GEOSGeometry.buffer_with_style().	2018-02-10 19:45:58 -05: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/