mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
Code Issues Releases Wiki Activity
646b9ce848
django/docs
History
Tim Graham 646b9ce848 Fixed typo in 1.8 release notes.
2014-09-04 10:23:32 -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 #23016 -- Updated FAQs per Aymeric's suggestions. 2014-08-12 13:46:10 -04:00
howto Fixed #18757, #14462, #21565 -- Reworked database-python type conversions 2014-09-03 20:36:03 +01:00
internals Fixed #18757, #14462, #21565 -- Reworked database-python type conversions 2014-09-03 20:36:03 +01:00
intro Fixed #23362 -- Clarified "database columns as attributes" in tutorial. 2014-08-26 10:00:33 -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 documentation links to Query Expression API. 2014-09-04 09:45:10 -04:00
releases Fixed typo in 1.8 release notes. 2014-09-04 10:23:32 -04:00
topics Fixed typo in docs/topics/db/transactions.txt. 2014-09-03 11:49:00 -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 some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Introduced a technical board. 2014-08-01 14:41:24 +02:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Added words to spelling_wordlist. 2014-08-26 09:44:07 -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 ``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/