mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-14 11:20:46 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Tim Graham f0c469c7be [1.4.x] Merge pull request #315 from streeter/auth-docs-cleanup-patch 
Clarify some of the password reset docs

Backport of 03ad7d3c2085fa252e7bf6a725fec1ed3d1e6a7c from master.
2012-09-01 18:06:25 -04:00
..
_ext
Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed
2012-01-11 10:19:05 +00:00
_theme/djangodocs
Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.
2010-07-24 10:21:21 +00:00
faq
[1.4.X] Fixed #17511 - Removed reference to deprecated "reset" management command in FAQ; thanks voxpuibr@ for the report.
2012-06-27 18:56:04 -04:00
howto
[1.4.x] Updated obsolete links in the documentation
2012-08-30 07:47:56 -04:00
internals
[1.4.x] Updated obsolete links in the documentation
2012-08-30 07:47:56 -04:00
intro
[1.4.x] Updated obsolete links in the documentation
2012-08-30 07:47:56 -04:00
man
[1.4.X] Fix lintian error in manpages.
2012-03-29 15:08:38 +00:00
misc
Replaced http by https in djangoproject.com links
2012-03-13 17:53:31 +00:00
obsolete
Fixed #14141: docs now use the :doc: construct for links between documents.
2010-08-19 19:27:44 +00:00
ref
[1.4.x] Fixed #13608 - Noted that template lookups use literal values.
2012-09-01 09:27:29 -04:00
releases
[1.4.x] Fixed #18212 -- Standardized arguments of GenericIPAddressField
2012-09-01 18:39:51 +02:00
topics
[1.4.x] Merge pull request #315 from streeter/auth-docs-cleanup-patch
2012-09-01 18:06:25 -04:00
conf.py
[1.4.x] Bump version numbers for security release.
2012-07-30 15:43:45 -05:00
contents.txt
Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch.
2010-12-27 23:58:16 +00:00
glossary.txt
Replaced http by https in djangoproject.com links
2012-03-13 17:53:31 +00:00
index.txt
Replaced http by https in djangoproject.com links
2012-03-13 17:53:31 +00:00
make.bat
Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.
2011-07-19 09:00:24 +00:00
Makefile
Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0.
2010-07-24 10:21:21 +00:00
README
Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112.
2012-03-03 09:11:54 +00:00

README 

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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 ``sudo 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.pocoo.org/