mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-19 07:54:07 +00:00
Code Issues 24 Releases Wiki Activity
4dc3be2506
django/docs
History
Anssi Kääriäinen 4dc3be2506 Fixed typos spotted by Claude Paroz
2014-01-18 22:31:35 +02:00
..
_ext Fixed E127 pep8 warnings. 2013-12-14 11:59:15 -05:00
_theme/djangodocs Fixed #21558 -- Support building CHM files. 2013-12-04 16:46:56 +01:00
faq Django sees more than 1mm hits per hour 2013-12-31 16:23:20 -08:00
howto Fixed #16187 -- refactored ORM lookup system 2014-01-18 11:46:19 +02:00
internals Removed BDFL stuff from docs/internals/contributing/bugs-and-features.txt 2014-01-13 10:32:09 -06:00
intro Fixed #21728 -- Corrected an inadvertent path change in docs/intro/contributing.txt. 2014-01-03 11:59:15 -05:00
man Removed a man page for a command that was removed 2014-01-10 15:23:06 -08:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed typos spotted by Claude Paroz 2014-01-18 22:31:35 +02:00
releases Fixed typos spotted by Claude Paroz 2014-01-18 22:31:35 +02:00
topics Removed some unnecessary __exact operators in filters. 2014-01-17 18:12:45 -05:00
conf.py Pointed intersphinx links to Python's default version. 2013-12-30 19:09:45 +01:00
contents.txt
glossary.txt
index.txt Fixed #16187 -- refactored ORM lookup system 2014-01-18 11:46:19 +02:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Whitespace cleanup. 2013-10-10 16:49:20 -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/