Home Explore Help
Sign In
CityApper
/
django
mirror of https://github.com/django/django
2
0
Fork 0
Files Issues 0 Wiki
Tree: 8ad3c41c69
Branches Tags
django
/
docs
Timo Graham 8ad3c41c69 Fixed #16093 - Typo in "Performing raw SQL queries"; thanks direvus. 14 years ago
..
_ext 66fd824ee0 Fixed djangodocs Sphinx extension to work with latest Sphinx 14 years ago
_theme fad4a93275 Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 14 years ago
faq 49f57a5d28 Fixed #15992 -- Added more references to settings. Thanks, aaugustin. 14 years ago
howto 49f57a5d28 Fixed #15992 -- Added more references to settings. Thanks, aaugustin. 14 years ago
internals 49f57a5d28 Fixed #15992 -- Added more references to settings. Thanks, aaugustin. 14 years ago
intro 80d6089029 Fixed #16051 - Changed a "file" reference in the tutorial to be an actual file rather than a module; thanks felix.morency for the suggestion. 14 years ago
man 6a32e253f6 Fixed #7735 -- Added support for IPv6 adresses to runserver and testserver management command. Thanks to Jason Alonso and Łukasz Rekucki for the report and initial patches. 14 years ago
misc 94af19c43f Changed e-mail to email throughout documentation and codebase. The one exception is translation strings, which I didn't want to disrupt 14 years ago
obsolete 728effcfbd Fixed #14141: docs now use the :doc: construct for links between documents. 14 years ago
ref 49f57a5d28 Fixed #15992 -- Added more references to settings. Thanks, aaugustin. 14 years ago
releases 49f57a5d28 Fixed #15992 -- Added more references to settings. Thanks, aaugustin. 14 years ago
topics 8ad3c41c69 Fixed #16093 - Typo in "Performing raw SQL queries"; thanks direvus. 14 years ago
Makefile fad4a93275 Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 14 years ago
README 4eec036ab3 Added a README for building offline HTML docs. 14 years ago
conf.py 1339ef4af8 Bumped django_next_version so that "New in Django 1.3" links appear correctly. 14 years ago
contents.txt 264d19752e Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch. 14 years ago
glossary.txt 16f4a2bec2 Minor markup and organization fixes to docs to correct Sphinx errors. 14 years ago
index.txt 407f62fd31 Fixed #15796 -- Restructured the contributing documentation and added note about newly added Trac abilities. Many thanks to Julien Phalip. 14 years ago

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` 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.pocoo.org/