django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Vytis Banaitis 8838d4dd49 Refs #23919 -- Replaced kwargs.pop() with keyword-only arguments.		2017-02-01 11:41:56 -05:00
..
_ext	Refs #23919 -- Replaced super(ClassName, self) with super() in docs.	2017-01-25 11:53:05 -05:00
_theme
faq	Refs #23919 -- Removed Python 2 notes in docs.	2017-01-18 11:51:29 -05:00
howto	Added missing word in docs/howto/error-reporting.txt.	2017-01-30 15:38:55 -05:00
internals	Refs #23919 -- Removed misc Python 2/3 references.	2017-01-25 13:59:25 -05:00
intro	Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow.	2017-01-28 11:45:04 -05:00
man
misc
ref	Fixed #27661 -- Moved FileSystemFinder's ImproperlyConfigured exceptions to system checks.	2017-02-01 09:48:24 -05:00
releases	Refs #23919 -- Removed usage of obsolete SafeBytes class	2017-01-30 15:04:45 +01:00
topics	Refs #23919 -- Replaced kwargs.pop() with keyword-only arguments.	2017-02-01 11:41:56 -05:00
conf.py	Refs #23919 -- Removed Python 2 notes in docs.	2017-01-18 11:51:29 -05:00
contents.txt
glossary.txt
index.txt	Refs #23919 -- Removed Python 2 notes in docs.	2017-01-18 11:51:29 -05:00
make.bat
Makefile
README
spelling_wordlist	Fixed #15667 -- Added template-based widget rendering.	2016-12-27 17:50:10 -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/