1
0
mirror of https://github.com/django/django.git synced 2025-01-13 11:57:01 +00:00
django/docs
André Ericson 1e5e2a4707 Fixed -- Add check for related_name
Validates that related_name is a valid Python id or ends with a '+' and
it's not a keyword. Without a check it passed silently leading to
unpredictable problems.

Thanks Konrad Świat for the initial work.
2014-10-04 20:47:26 -03:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Fixed -- Removed Cheetah references in docs 2014-09-21 18:03:31 +02:00
howto Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
internals Added my bio to team.txt 2014-09-24 22:45:03 -04:00
intro Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
man Replaced django-admin.py with django-admin in the man page. 2014-07-31 23:46:49 +02:00
misc
ref Fixed -- Add check for related_name 2014-10-04 20:47:26 -03:00
releases Fixed -- Added SingleObjectMixin.query_pk_and_slug 2014-10-02 15:42:30 -04:00
topics Fixed -- Added support for timezone-aware datetimes to migrations. 2014-09-29 20:45:43 -04:00
conf.py Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed -- Added "concrete model" to glossary. 2014-09-08 08:45:47 -04:00
index.txt Fixed -- Integrated django-secure and added check --deploy option 2014-09-12 15:05:23 -04:00
make.bat Fixed - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Updated docs/spelling_wordlist 2014-10-02 11:52:05 +01: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/