mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-26 11:06:07 +00:00
Code Issues 25 Releases Wiki Activity
c1c163b427
django/docs
History
Tom c1c163b427 Fixed #28574 -- Added QuerySet.explain().
2018-04-19 10:52:19 -04:00
..
_ext Bumped minimum Sphinx version to 1.6.0. 2018-03-22 20:30:03 -04:00
_theme Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
faq
howto Fixed #29334 -- Updated pypi.python.org URLs to pypi.org. 2018-04-17 20:24:27 -04:00
internals Fixed #29334 -- Updated pypi.python.org URLs to pypi.org. 2018-04-17 20:24:27 -04:00
intro Clarified wording in tutorial text. 2018-04-19 11:09:38 +02:00
man
misc
ref Fixed #28574 -- Added QuerySet.explain(). 2018-04-19 10:52:19 -04:00
releases Fixed #28574 -- Added QuerySet.explain(). 2018-04-19 10:52:19 -04:00
topics Fixed #29212 -- Doc'd redirect loop if @permission_required used with redirect_authenticated_user. 2018-04-19 10:21:24 -04:00
conf.py Updated intersphinx_mapping URL for sphinx. 2018-04-04 11:32:14 -04:00
contents.txt
glossary.txt
index.txt Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat
Makefile
README
spelling_wordlist Fixed #28960 -- Added GEOSGeometry.buffer_with_style(). 2018-02-10 19:45:58 -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/