mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
a46742e738
django/docs
History
Tim Graham a46742e738 Added a CVE role for Sphinx.
2016-09-26 15:48:40 -04:00
..
_ext Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
_theme
faq Added Django 1.11, 2.0 to Python version support table. 2016-08-26 17:21:46 -04:00
howto Fixed #27212 -- Fixed typo in docs/howto/static-files/index.txt. 2016-09-12 16:05:27 -04:00
internals Doc'd how to use GitHub's "Squash and merge" button. 2016-09-21 12:13:21 -04:00
intro Fixed #27174 -- Explained where PollsConfig comes from in tutorial 2. 2016-09-07 14:12:53 -04:00
man
misc
ref Fixed #27276 -- Doc'd how to reverse admin's login view. 2016-09-26 10:38:34 -04:00
releases Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
topics Fixed #27278 -- Fixed an anchor in docs/topics/forms/formsets.txt. 2016-09-26 13:55:39 -04:00
conf.py Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
contents.txt
glossary.txt
index.txt Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
Makefile
README
spelling_wordlist Added myself to ops team (#7273) 2016-09-21 09:42:00 +02: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/