mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
Code Issues 25 Releases Wiki Activity
8ec388a69d
django/docs
History
Tim Graham 8ec388a69d Fixed #22442 -- Provided additional documentation regarding id fields clashing. 
Thanks benjaoming for raising the issue and Loic for the examples.
2014-04-30 07:36:12 -04:00
..
_ext
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Fixed #22497 -- Highlighted difference between field and class deconstruction. 2014-04-28 08:18:43 -04:00
internals Fixed #3214 -- Stopped parsing SQL with regex. 2014-04-26 17:46:23 +02:00
intro Updated doc links to point to Python 3 documentation 2014-04-26 16:02:53 +02:00
man Fixed #22328 -- Added --exclude option to compilemessages and makemessages. 2014-04-26 17:07:44 +07:00
misc
ref Improved formatting and links of migration docs. 2014-04-27 15:05:41 -04:00
releases Fixed #22442 -- Provided additional documentation regarding id fields clashing. 2014-04-30 07:36:12 -04:00
topics Fixed #22442 -- Provided additional documentation regarding id fields clashing. 2014-04-30 07:36:12 -04:00
conf.py Updated doc links to point to Python 3 documentation 2014-04-26 16:02:53 +02:00
contents.txt
glossary.txt
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Various documentation typo/spelling fixes 2014-04-23 02:31:49 +03: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 ``sudo 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/