mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00
Code Issues 25 Releases Wiki Activity
b7dc998087
django/docs
History
Tim Graham b7dc998087 Added "reraising" to docs/spelling_wordlist
2017-04-20 13:03:24 -04:00
..
_ext Refs #23919 -- Replaced super(ClassName, self) with super() in docs. 2017-01-25 11:53:05 -05:00
_theme
faq Removed an obsolete temporal reference in docs/faq/general.txt. 2017-03-21 08:20:54 -04:00
howto Fixed #28031 -- Removed notes about old uWSGI/sentry versions (refs #20537). 2017-04-06 09:09:49 -04:00
internals Removed inappropriate highlighting in committing-code.txt. 2017-04-20 11:32:56 -04:00
intro Fixed #28069 -- Moved setup_test_environment() warning in tutorial 5. 2017-04-12 08:17:46 -04:00
man
misc
ref Fixed #28067 -- Clarified __str__() return type when using python_2_unicode_compatible(). 2017-04-14 08:05:58 -04:00
releases Refs #28091 -- Forwardported 1.11.1 release note. 2017-04-20 12:58:24 -04:00
topics Fixed typos in docs/topic/db/search.txt. 2017-04-08 07:26:15 -04:00
conf.py Refs #23919 -- Removed Python 2 notes in docs. 2017-01-18 11:51:29 -05:00
contents.txt
glossary.txt
index.txt Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:36:44 -04:00
make.bat
Makefile
README
spelling_wordlist Added "reraising" to docs/spelling_wordlist 2017-04-20 13:03:24 -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/