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
f3427ccb25
django/docs
History
Mariusz Felisiak f3427ccb25 Refs #28138 -- Added release notes for d52577b62b.
2017-04-28 13:15:05 -04:00
..
_ext Refs #23919 -- Replaced super(ClassName, self) with super() in docs. 2017-01-25 11:53:05 -05:00
_theme
faq Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
howto Refs #27795 -- Replaced many force_text() with str() 2017-04-27 09:10:02 +02:00
internals Fixed #28137 -- Deprecated HttpRequest.xreadlines(). 2017-04-26 19:39:22 -04:00
intro Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
man
misc
ref Fixed #28037 -- Clarified that QueryDict.items()/values() are generators. 2017-04-26 20:51:28 -04:00
releases Refs #28138 -- Added release notes for d52577b62b. 2017-04-28 13:15:05 -04:00
topics Refs #27795 -- Replaced many force_text() with str() 2017-04-27 09:10:02 +02: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 Fixed #27644 -- Doc'd FileSystemStorage.get_created_time(). 2017-04-26 13:33:35 -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/