mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
Code Issues 24 Releases Wiki Activity
4eec036ab3
django/docs
History
Luke Plant 4eec036ab3 Added a README for building offline HTML docs. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14478 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2010-11-06 17:44:26 +00:00
..
_ext Fixed hyperlinking of template tags/filters in offline docs so that non-builtin tags/filters are not hyperlinked to a page where no docs for them exist 2010-11-06 17:42:21 +00:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Clarify in the documentation that we occasionally add APIs for newer Python versions. Thanks to Russell, Jannis, and Carl for help with the language. 2010-10-18 01:20:40 +00:00
howto Documented options accepted by the runfcgi management command. 2010-10-27 15:35:07 +00:00
internals Fixed #6735 -- Added class-based views. 2010-10-18 13:34:47 +00:00
intro Fixed #14627 -- Made Tutorial 3 more explicit regarding the transformations the URLconf undergoes in the final two sections, and gave an example of concatenating two patterns() in the process. Thanks to filmer for the report. 2010-11-06 10:06:30 +00:00
man Fixed #6476 -- Added option to makemessages management command to disable wrapping of long lines. Thanks to pytechd for the initial patch. 2010-11-04 12:08:37 +00:00
misc Fixed #14455 -- Documented the backwards compatibility policy for local flavors. Implemented the policy for the changes in the Indonesian local flavor (from r14195) that stimulated the development of this policy. Thanks to Karen, Alex, Ramiro and Chris for their help developing the policy. 2010-11-01 00:52:58 +00:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Fixed #6476 -- Added option to makemessages management command to disable wrapping of long lines. Thanks to pytechd for the initial patch. 2010-11-04 12:08:37 +00:00
releases Fixed #9988 -- Added support for translation contexts. Thanks, Claude Paroz. 2010-11-04 10:48:27 +00:00
topics Fixed #14624 -- Updated a few outdated references to CacheMiddleware in the transactions topic guide. Thanks to quinode for the report. 2010-11-06 09:19:53 +00:00
conf.py Disabled unused Sphinx configuration option that triggered a warning. 2010-10-08 15:33:27 +00:00
contents.txt
glossary.txt Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
index.txt Fixed #12323 and #11582 -- Extended the ability to handle static files. Thanks to all for helping with the original app, the patch, documentation and general support. 2010-10-20 01:33:24 +00:00
Makefile Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
README Added a README for building offline HTML docs. 2010-11-06 17:44:26 +00:00

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/