test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
django/docs
History
Tim Graham f43291639b Added stub release notes for security issues. 2016-03-01 11:25:28 -05:00
..
_ext Fixed #23868 -- Added support for non-unique django-admin-options in docs. 2016-01-14 18:21:33 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -05:00
howto Fixed #26243 -- Noted that 'python -R' is enabled by default in Python 3.3. 2016-02-19 10:50:15 -05:00
internals Minor fixes for release-process doc fix 2016-02-28 19:30:18 +02:00
intro Fixed #26221 -- Used find_packages() in reusable apps tutorial. 2016-02-15 19:25:26 -05:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Fixed #26217 -- Added a warning about format strings to WeekArchiveView docs. 2016-03-01 10:29:52 -05:00
releases Added stub release notes for security issues. 2016-03-01 11:25:28 -05:00
topics Corrected a run on sentence in doc/topics/db/models.txt. 2016-02-25 14:22:41 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:30:32 -05:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Added 'prefetches to docs/spelling_wordlist. 2016-02-26 16:06:34 -05: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/