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
003334f8af
django/docs
History
Luoxzhg 99539ca319 Fixed typo in docs/topics/db/managers.txt.
2018-04-11 22:24:29 -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 Fixed #27855 -- Updated docs for Python 3.4 support in Django 2.0. 2017-08-11 11:17:08 -04:00
howto Replaced 'python -Wall' with 'python -Wa'. 2018-03-28 13:25:03 -04:00
internals Updated contributing docs for some latest practices. 2018-04-06 20:46:06 -04:00
intro isorted import statements in tutorial example 2018-03-22 08:53:56 +01:00
man Updated man page for Django 2.0 alpha. 2017-09-22 12:28:56 -04:00
misc
ref Fixed #27991 -- Added obj arg to InlineModelAdmin.has_add_permission(). 2018-04-04 19:21:50 -04:00
releases Refs #28062 -- Doc'd PostgreSQL server-side cursors as a backwards incompatible change. 2018-04-10 13:26:50 -04:00
topics Fixed typo in docs/topics/db/managers.txt. 2018-04-11 22:24:29 -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/