django/docs
Thijs van Dien f5e1d72de2 [1.9.x] Fixed #25473 -- Changed underscores in url() names to dashes in docs.
To improve consistency, sample URL names that had underscores
in them now use dashes instead. That excludes URL names that
have some relation to the code, such as those generated by
the admin.

Thanks guettli for reporting this.

Backport of 1679472165 from master
2015-11-07 21:59:59 +01: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 [1.9.x] Added Django 1.10 to Python version support table. 2015-10-26 10:36:44 -04:00
howto [1.9.x] Revised Windows install instructions for Python 3.5. 2015-10-21 20:27:21 -04:00
internals [1.9.x] Optimized docs images and documented the process. 2015-10-24 14:57:48 -04:00
intro [1.9.x] Optimized docs images and documented the process. 2015-10-24 14:57:48 -04:00
man [1.9.x] Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:32:28 -04:00
misc Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
ref [1.9.x] Fixed #25473 -- Changed underscores in url() names to dashes in docs. 2015-11-07 21:59:59 +01:00
releases [1.9.x] Added stub release notes for 1.8.7. 2015-11-05 09:43:42 +01:00
topics [1.9.x] Fixed #25473 -- Changed underscores in url() names to dashes in docs. 2015-11-07 21:59:59 +01: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 [1.9.x] Bumped django_next_version in docs config. 2015-09-23 19:36:23 -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 [1.9.x] Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:32:28 -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/