mirror of
https://github.com/Hopiu/django.git
synced 2026-04-15 20:41:17 +00:00
70fac984c8
It appears that our infamous villain, Significant Whitespace, has struck again. In this episode, little Timmy finds himself trapped in a code well. He need not despair, however, as Indentation Man has heard his cries for help and sprung into action. With his feline helper, Octocat, at his side, Indentation Man races to the scene, flings open a web-based code editor, and with terrific aplomb, frees Timmy to be the documentation he always wanted to be. Once again Goodness has prevailed. In the fight for readable documentation, no stray whitespace will ever be able to withstand the str.strip()ing nature of....INDENTATION MAN. |
||
|---|---|---|
| .. | ||
| _ext | ||
| _theme/djangodocs | ||
| faq | ||
| howto | ||
| internals | ||
| intro | ||
| man | ||
| misc | ||
| ref | ||
| releases | ||
| topics | ||
| conf.py | ||
| contents.txt | ||
| glossary.txt | ||
| index.txt | ||
| make.bat | ||
| Makefile | ||
| 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.pocoo.org/