mirror of
https://github.com/django/django.git
synced 2025-02-09 08:55:32 +00:00
2a0ae9b9ec
The settings reference documentation doesn't seem the right place to invite users to write their own db and cache backends. Also the actual wording makes the task sound trivial, which is hardly the case; writing a custom db backend is a very difficult task, and writing a custom cache backend is full of gotcha.
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/