mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 24 Releases Wiki Activity
django/docs
History
Carlton Gibson a394289b58
Fixed #30036 -- Removed unused imports in pagination example. 		2018-12-12 18:49:47 +01:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq Refs #28814 -- Doc'd Python 3.7 compatibility in Django 1.11.x. 2018-11-17 15:40:35 -05:00
howto Fixed #29895 -- Doc'd why MySQL's atomic DDL statements don't work for atomic migrations. 2018-12-06 16:03:02 -05:00
internals Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
intro Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
man Updated man page for Django 2.1 alpha. 2018-05-17 09:30:20 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Fixed #28766 -- Added ResolverMatch.route. 2018-12-06 18:05:40 -05:00
releases Added blank line in docs/releases/2.2.txt. 2018-12-09 10:26:55 -05:00
topics Fixed #30036 -- Removed unused imports in pagination example. 2018-12-12 18:49:47 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Removed obsolete html_use_smartypants Sphinx option. 2018-09-18 11:51:04 -04: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 Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
make.bat
…
spelling_wordlist Fixed #28990 -- Added autosummarize parameter to BrinIndex. 2018-08-02 11:26:58 -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/