1
0
mirror of https://github.com/django/django.git synced 2024-12-25 10:35:48 +00:00
django/docs
Floris den Hengst bd36f2d432 [1.8.x] Fixed doc typos.
Backport of e42a720ba2 from master
2015-03-14 12:29:27 -04:00
..
_ext [1.8.x] Sorted imports with isort; refs #23860. 2015-02-09 14:24:06 -05:00
_theme
faq Used https for most *.python.org links 2014-12-19 18:07:52 +01:00
howto [1.8.x] Added link to section in docs/howto/custom-template-tags.txt. 2015-03-13 08:26:28 -04:00
internals [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
intro [1.8.x] Improved wording in tutorial 1. 2015-02-27 17:54:27 -05:00
man [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
misc
ref [1.8.x] Fixed doc typos. 2015-03-14 12:29:27 -04:00
releases [1.8.x] Added stub release notes for 1.7.7. 2015-03-09 13:10:09 -04:00
topics [1.8.x] Fixed doc typos. 2015-03-14 12:29:27 -04:00
conf.py [1.8.x] Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:15:40 -04:00
contents.txt
glossary.txt
index.txt [1.8.x] Added a "Writing migrations" how-to. 2015-02-03 13:46:56 -05:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README
spelling_wordlist [1.8.x] Reverted "Fixed #24325 -- Documented change in ModelForm.save() foreign key access." 2015-02-24 11:51:10 -05:00

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/