mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
Code Issues Releases Wiki Activity
ab8d8e00c9
django/docs
History
Tim Graham ab8d8e00c9 Improved formatting and links of migration docs.
2014-04-27 15:05:41 -04:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_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 Specified 'csv and unicode' note as Python 2 only 2014-04-26 16:09:19 +02: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 Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Improved formatting and links of migration docs. 2014-04-27 15:05:41 -04:00
releases Improved formatting and links of migration docs. 2014-04-27 15:05:41 -04:00
topics Improved formatting and links of migration docs. 2014-04-27 15:05:41 -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 Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
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 Whitespace cleanup. 2013-10-10 16:49:20 -04:00
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/