p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
Markus Holtermann f33607ce0b Fixed style issues in testing docs 2015-08-19 12:18:10 +10:00
..
_ext Removed obsolete literals_to_xrefs.py script. 2015-06-15 10:22:18 -04:00
_theme Added white-space: pre-wrap; to docs code blocks to match docs.dp.com. 2015-06-22 15:56:06 -04:00
faq Updated various links in docs 2015-08-08 13:57:15 +02:00
howto Removed unnecessary comma in docs 2015-08-10 16:02:14 +02:00
internals Used consistent capitalization and hyphenation of "class-based views" in docs. 2015-08-18 19:07:10 -04:00
intro Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
ref Used consistent capitalization and hyphenation of "class-based views" in docs. 2015-08-18 19:07:10 -04:00
releases Added stub release notes for 1.8.5. 2015-08-18 19:52:45 -04:00
topics Fixed style issues in testing docs 2015-08-19 12:18:10 +10:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:41:39 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Refs #25236 -- Discouraged use of ifequal/ifnotequal template tags. 2015-08-08 08:23:33 -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/