mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-19 16:04:13 +00:00
Code Issues 24 Releases Wiki Activity
90c59db7a3
django/docs
History
Tim Graham 90c59db7a3 Forwardported release notes for refs #24903.
2015-06-09 17:57:21 -04:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme Optimise the rest of the PNGs in docs 2015-05-29 15:22:40 +10:00
faq Removed Django 1.6 from the Python version chart. 2015-04-02 14:21:01 -04:00
howto Fixed #24882 -- Documented Migration.run_before 2015-06-06 09:00:04 -04:00
internals Fixed #21927 -- Made application and instance namespaces more distinct. 2015-06-08 15:12:20 -04:00
intro Fixed #21927 -- Made application and instance namespaces more distinct. 2015-06-08 15:12:20 -04:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc
ref Fixed import in docs/ref/contrib/syndication.txt 2015-06-09 12:36:34 -04:00
releases Forwardported release notes for refs #24903. 2015-06-09 17:57:21 -04:00
topics Fixed typos in docs/topics/python3.txt 2015-06-09 10:36:46 -04:00
conf.py Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:41:39 -04:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Fixed #24907 -- Updated contributing tutorial with a more recent example ticket. 2015-06-06 08:36:50 -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/