mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
eb13e6cb9a
django/docs
History
Carlton Gibson eb13e6cb9a Added release date for 2.1.2 release.
2018-11-01 15:02:22 +01:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq Fixed #29261 -- Doc'd the reason for LICENSE.python. 2018-06-29 20:00:58 -04:00
howto Simplified deployment checklist docs on customizing error views. 2018-10-11 09:50:08 -04:00
internals Fixed #28606 -- Deprecated CachedStaticFilesStorage. 2018-10-27 11:58:29 -04:00
intro Fixed #22390 -- Doc'd possible server restart required in tutorial 6. 2018-10-31 20:50:10 -04:00
man
misc
ref Capitalized SecurityMiddleware headers for consistency with other headers. 2018-10-30 18:30:51 -04:00
releases Added release date for 2.1.2 release. 2018-11-01 15:02:22 +01:00
topics Fixed #28606 -- Deprecated CachedStaticFilesStorage. 2018-10-27 11:58:29 -04:00
conf.py Removed obsolete html_use_smartypants Sphinx option. 2018-09-18 11:51:04 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist Fixed #28990 -- Added autosummarize parameter to BrinIndex. 2018-08-02 11:26:58 -04:00

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 ``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/