mirror of
https://github.com/django/django.git
synced 2024-12-22 17:16:24 +00:00
e303739f8e
Refs
|
||
---|---|---|
.. | ||
_ext | ||
_theme | ||
faq | ||
howto | ||
internals | ||
intro | ||
man | ||
misc | ||
ref | ||
releases | ||
topics | ||
conf.py | ||
contents.txt | ||
glossary.txt | ||
index.txt | ||
make.bat | ||
Makefile | ||
README | ||
spelling_wordlist |
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 ``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/