mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-26 11:06:07 +00:00
Code Issues 27 Releases Wiki Activity
349c15b45e
django/docs
History
Tim Graham 2011c7a031 [1.8.x] Added release date for Django 1.8. 
Backport of 61d6c5d02e from master
2015-04-01 15:31:16 -04:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -05:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
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] Fixed #24519 -- Clarified location of templates directory in tutorial 2. 2015-03-27 09:58:44 -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 typo in docs/ref/templates/builtins.txt 2015-03-31 21:21:50 -04:00
releases [1.8.x] Added release date for Django 1.8. 2015-04-01 15:31:16 -04:00
topics [1.8.x] Fixed typo in docs/topics/cache.txt 2015-03-31 21:16:26 -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 Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -05:00
make.bat
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
spelling_wordlist [1.8.x] Reverted "Fixed #24325 -- Documented change in ModelForm.save() foreign key access." 2015-02-24 11:51:10 -05: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/