mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
Code Issues 25 Releases Wiki Activity
92107522ed
django/docs
History
Christophe Pettus 92107522ed Fixed #26684 -- Removed incorrect index example in docs/ref/contrib/postgres/search.txt.
2016-05-30 14:21:05 -04: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 Removed versionadded/changed annotations for 1.9. 2016-05-20 11:44:29 -04:00
internals Added RemovedInDjango21Warning 2016-05-28 21:12:39 -04:00
intro Fixed #26483 -- Updated docs.python.org links to use Intersphinx. 2016-05-08 18:07:43 -04: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 #26684 -- Removed incorrect index example in docs/ref/contrib/postgres/search.txt. 2016-05-30 14:21:05 -04:00
releases Fixed #26646 -- Added IOBase methods required by TextIOWrapper to File. 2016-05-27 21:05:58 -04:00
topics Refs #22634 -- Removed unneeded app_label in custom session engine example. 2016-05-28 17:32:37 -04:00
conf.py Bumped version; master is now 1.11 pre-alpha. 2016-05-19 22:20:21 -04: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 Refs #3254 -- Added full text search to contrib.postgres. 2016-04-22 10:44:37 +01:00
make.bat
Makefile
README
spelling_wordlist Fixed #26646 -- Added IOBase methods required by TextIOWrapper to File. 2016-05-27 21:05:58 -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/