1
0
mirror of https://github.com/django/django.git synced 2024-12-29 04:26:28 +00:00
django/docs
Bas Peschier 015a9b928a [1.8.x] Fixed #13525 -- Added tests and docs for nested parameters in URL patterns.
When reversing, only outer parameters are used if captured parameters are
nested. Added tests to check the edge cases and documentation for the
behavior with an example to avoid it.

Backport of 23a5d64f40 from master
2015-03-23 08:43:58 -04:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -05:00
_theme
faq
howto [1.8.x] Updated location of database backend data_types attribute in docs. 2015-03-17 20:04:30 -04:00
internals [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
intro [1.8.x] Added missing punctuation in some comments in tutorial 5. 2015-03-16 08:24:58 -04:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc
ref [1.8.x] Fixed #23814 -- Pointed localflavor documentation to external package 2015-03-22 15:36:44 +01:00
releases [1.8.x] Made is_safe_url() reject URLs that start with control characters. 2015-03-18 19:23:21 -04:00
topics [1.8.x] Fixed #13525 -- Added tests and docs for nested parameters in URL patterns. 2015-03-23 08:43:58 -04:00
conf.py [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
contents.txt
glossary.txt
index.txt [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -05:00
make.bat
Makefile
README
spelling_wordlist [1.8.x] Reverted "Fixed #24325 -- Documented change in ModelForm.save() foreign key access." 2015-02-24 11:51:10 -05:00

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/