mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-20 00:14:08 +00:00
Code Issues 24 Releases Wiki Activity
066e672d79
django/docs
History
Markus Holtermann 066e672d79 Fixed #23473 -- Documented that @deconstructible classes need __eq__.
2014-09-24 14:19:11 -04: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 #23527 -- 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 Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -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 Corrected --noinput docs for makemigrations; refs #23407. 2014-09-24 13:29:07 -04:00
releases Fixed #23426 -- Don't require double percent sign in RunSQL without parameters 2014-09-24 07:20:57 -04:00
topics Fixed #23473 -- Documented that @deconstructible classes need __eq__. 2014-09-24 14:19:11 -04:00
conf.py Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
contents.txt
glossary.txt Fixed #23281 -- Added "concrete model" to glossary. 2014-09-08 08:45:47 -04:00
index.txt Fixed #17101 -- Integrated django-secure and added check --deploy option 2014-09-12 15:05:23 -04:00
make.bat
Makefile Fixed #22141 -- 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 Fixed typo in docs/internals/roles.txt and added words to spelling_wordlist. 2014-09-16 08:38:51 -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/