mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-04 02:48:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
django/docs
History
Curtis Maloney 1853e2dbf2 [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 
Backport of c49ea6f591 from master
2018-09-10 14:38:08 -04:00
..
_ext [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
_theme [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
faq [2.1.x] Refs #28814 -- Documented Python 3.7 compatibility. 2018-06-28 11:05:32 -04:00
howto [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
internals [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
intro [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
man Updated man page for Django 2.1 alpha. 2018-05-17 09:30:20 -04:00
misc
ref [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
releases [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
topics [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
conf.py [2.1.x] Bumped django_next_version in sphinx config to 2.2. 2018-05-17 20:49:30 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist [2.1.x] Fixed typos in comments and docs. 2018-08-01 16:13:18 -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/